Microsoft.DocumentDB cassandraClusters 2021-04-01-preview
- najnowsze
- 2024-12-01-preview
- 2024-11-15
- 2024-09-01-preview
- 2024-08-15
- 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ć 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 dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/cassandraClusters, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2021-04-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
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'
}
tags: {
{customized property}: 'string'
}
}
Wartości właściwości
Certyfikat
| Nazwa | Opis | Wartość |
|---|---|---|
| Pem | Klucz publiczny sformatowany przez PEM. | struna |
ClusterResourceProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| authenticationMethod | Która metoda uwierzytelniania cassandra powinna używać do uwierzytelniania klientów. Opcja "Brak" wyłącza uwierzytelnianie, dlatego nie należy jej używać z wyjątkiem sytuacji nadzwyczajnych. "Cassandra" to domyślne uwierzytelnianie oparte na hasłach. Wartość domyślna to "Cassandra". | "Cassandra" "Brak" |
| cassandraVersion | Która wersja rozwiązania Cassandra powinna być zbieżna z działaniem klastra (np. 3.11). Po zaktualizowaniu klastra migracja do nowej wersji może zająć trochę czasu. | struna |
| 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 parametr clientCertificates jest ustawiony, 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. | certyfikatu [] |
| clusterNameOverride | Jeśli musisz ustawić właściwość clusterName w pliku cassandra.yaml na wartość inną niż nazwa zasobu klastra, ustaw wartość, która ma być używana w tej właściwości. | struna |
| 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/<identyfikator subskrypcji>/resourceGroups/<grupy zasobów>/providers/Microsoft.Network/virtualNetworks/<sieci wirtualnej>/subnets/<podsieci>" | struna |
| 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. | certyfikatu [] |
| 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 | Liczba godzin oczekiwania między utworzeniem kopii zapasowej klastra. Aby wyłączyć kopie zapasowe, ustaw tę właściwość na 0. | 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 w pliku GET. To pole ma zastosowanie tylko wtedy, gdy pole authenticationMethod ma wartość "Cassandra". | struna 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 |
| provisioningState | Stan zasobu w momencie wywołania operacji. | "Anulowano" "Tworzenie" "Usuwanie" "Niepowodzenie" "Powodzenie" "Aktualizowanie" |
| repairEnabled | Czy automatyczne naprawy powinny być uruchamiane w tym klastrze? 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. | struna |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Nazwa | Opis | Wartość |
|---|
ManagedServiceIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| userAssignedIdentities | Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nazwa | Opis | Wartość |
|---|
Microsoft.DocumentDB/cassandraClusters
| Nazwa | Opis | Wartość |
|---|---|---|
| tożsamość | Tożsamość zasobu. | ManagedServiceIdentity |
| lokalizacja | Lokalizacja grupy zasobów, do której należy zasób. | struna |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 Wzorzec = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (wymagane) |
| Właściwości | Właściwości zarządzanego klastra Cassandra. | ClusterResourceProperties |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
SeedNode
| Nazwa | Opis | Wartość |
|---|---|---|
| ipAddress | Adres IP tego węzła inicjowania. | struna |
Tagi
| Nazwa | Opis | Wartość |
|---|
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 dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/cassandraClusters, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.DocumentDB/cassandraClusters",
"apiVersion": "2021-04-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"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"
},
"tags": {
"{customized property}": "string"
}
}
Wartości właściwości
Certyfikat
| Nazwa | Opis | Wartość |
|---|---|---|
| Pem | Klucz publiczny sformatowany przez PEM. | struna |
ClusterResourceProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| authenticationMethod | Która metoda uwierzytelniania cassandra powinna używać do uwierzytelniania klientów. Opcja "Brak" wyłącza uwierzytelnianie, dlatego nie należy jej używać z wyjątkiem sytuacji nadzwyczajnych. "Cassandra" to domyślne uwierzytelnianie oparte na hasłach. Wartość domyślna to "Cassandra". | "Cassandra" "Brak" |
| cassandraVersion | Która wersja rozwiązania Cassandra powinna być zbieżna z działaniem klastra (np. 3.11). Po zaktualizowaniu klastra migracja do nowej wersji może zająć trochę czasu. | struna |
| 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 parametr clientCertificates jest ustawiony, 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. | certyfikatu [] |
| clusterNameOverride | Jeśli musisz ustawić właściwość clusterName w pliku cassandra.yaml na wartość inną niż nazwa zasobu klastra, ustaw wartość, która ma być używana w tej właściwości. | struna |
| 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/<identyfikator subskrypcji>/resourceGroups/<grupy zasobów>/providers/Microsoft.Network/virtualNetworks/<sieci wirtualnej>/subnets/<podsieci>" | struna |
| 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. | certyfikatu [] |
| 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 | Liczba godzin oczekiwania między utworzeniem kopii zapasowej klastra. Aby wyłączyć kopie zapasowe, ustaw tę właściwość na 0. | 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 w pliku GET. To pole ma zastosowanie tylko wtedy, gdy pole authenticationMethod ma wartość "Cassandra". | struna 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 |
| provisioningState | Stan zasobu w momencie wywołania operacji. | "Anulowano" "Tworzenie" "Usuwanie" "Niepowodzenie" "Powodzenie" "Aktualizowanie" |
| repairEnabled | Czy automatyczne naprawy powinny być uruchamiane w tym klastrze? 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. | struna |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Nazwa | Opis | Wartość |
|---|
ManagedServiceIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| userAssignedIdentities | Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nazwa | Opis | Wartość |
|---|
Microsoft.DocumentDB/cassandraClusters
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion | Wersja interfejsu API | "2021-04-01-preview" |
| tożsamość | Tożsamość zasobu. | ManagedServiceIdentity |
| lokalizacja | Lokalizacja grupy zasobów, do której należy zasób. | struna |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 Wzorzec = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (wymagane) |
| Właściwości | Właściwości zarządzanego klastra Cassandra. | ClusterResourceProperties |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
| typ | Typ zasobu | "Microsoft.DocumentDB/cassandraClusters" |
SeedNode
| Nazwa | Opis | Wartość |
|---|---|---|
| ipAddress | Adres IP tego węzła inicjowania. | struna |
Tagi
| Nazwa | Opis | Wartość |
|---|
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu cassandraClusters można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika 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@2021-04-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
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"
}
})
}
Wartości właściwości
Certyfikat
| Nazwa | Opis | Wartość |
|---|---|---|
| Pem | Klucz publiczny sformatowany przez PEM. | struna |
ClusterResourceProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| authenticationMethod | Która metoda uwierzytelniania cassandra powinna używać do uwierzytelniania klientów. Opcja "Brak" wyłącza uwierzytelnianie, dlatego nie należy jej używać z wyjątkiem sytuacji nadzwyczajnych. "Cassandra" to domyślne uwierzytelnianie oparte na hasłach. Wartość domyślna to "Cassandra". | "Cassandra" "Brak" |
| cassandraVersion | Która wersja rozwiązania Cassandra powinna być zbieżna z działaniem klastra (np. 3.11). Po zaktualizowaniu klastra migracja do nowej wersji może zająć trochę czasu. | struna |
| 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 parametr clientCertificates jest ustawiony, 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. | certyfikatu [] |
| clusterNameOverride | Jeśli musisz ustawić właściwość clusterName w pliku cassandra.yaml na wartość inną niż nazwa zasobu klastra, ustaw wartość, która ma być używana w tej właściwości. | struna |
| 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/<identyfikator subskrypcji>/resourceGroups/<grupy zasobów>/providers/Microsoft.Network/virtualNetworks/<sieci wirtualnej>/subnets/<podsieci>" | struna |
| 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. | certyfikatu [] |
| 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 | Liczba godzin oczekiwania między utworzeniem kopii zapasowej klastra. Aby wyłączyć kopie zapasowe, ustaw tę właściwość na 0. | 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 w pliku GET. To pole ma zastosowanie tylko wtedy, gdy pole authenticationMethod ma wartość "Cassandra". | struna 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 |
| provisioningState | Stan zasobu w momencie wywołania operacji. | "Anulowano" "Tworzenie" "Usuwanie" "Niepowodzenie" "Powodzenie" "Aktualizowanie" |
| repairEnabled | Czy automatyczne naprawy powinny być uruchamiane w tym klastrze? 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. | struna |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Nazwa | Opis | Wartość |
|---|
ManagedServiceIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| userAssignedIdentities | Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nazwa | Opis | Wartość |
|---|
Microsoft.DocumentDB/cassandraClusters
| Nazwa | Opis | Wartość |
|---|---|---|
| tożsamość | Tożsamość zasobu. | ManagedServiceIdentity |
| lokalizacja | Lokalizacja grupy zasobów, do której należy zasób. | struna |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 Wzorzec = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (wymagane) |
| Właściwości | Właściwości zarządzanego klastra Cassandra. | ClusterResourceProperties |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. |
| typ | Typ zasobu | "Microsoft.DocumentDB/cassandraClusters@2021-04-01-preview" |
SeedNode
| Nazwa | Opis | Wartość |
|---|---|---|
| ipAddress | Adres IP tego węzła inicjowania. | struna |
Tagi
| Nazwa | Opis | Wartość |
|---|