Udostępnij za pośrednictwem

Microsoft.DocumentDB cassandraClusters 2023-11-15

  • Artykuł

Definicja zasobu Bicep

Typ zasobu cassandraClusters można wdrożyć przy użyciu operacji docelowych:

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@2023-11-15' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: '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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

CassandraError

Nazwa Opis Wartość
additionalErrorInfo Dodatkowe informacje o błędzie. struna
kod Kod błędu, który wystąpił. struna
Komunikat Komunikat o błędzie. struna
cel Zasób docelowy błędu. struna

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"
"Ldap"
"Brak"
cassandraAuditLoggingEnabled Czy rejestrowanie inspekcji cassandra jest włączone Bool
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
Dealokowane Określa, 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/<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 (Przestarzałe) Liczba godzin oczekiwania między utworzeniem 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 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
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? 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

ManagedCassandraManagedServiceIdentity

Nazwa Opis Wartość
typ Typ zasobu. "Brak"
"SystemAssigned"

Microsoft.DocumentDB/cassandraClusters

Nazwa Opis Wartość
tożsamość Tożsamość zasobu. ManagedCassandraManagedServiceIdentity
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:

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": "2023-11-15",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

CassandraError

Nazwa Opis Wartość
additionalErrorInfo Dodatkowe informacje o błędzie. struna
kod Kod błędu, który wystąpił. struna
Komunikat Komunikat o błędzie. struna
cel Zasób docelowy błędu. struna

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"
"Ldap"
"Brak"
cassandraAuditLoggingEnabled Czy rejestrowanie inspekcji cassandra jest włączone Bool
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
Dealokowane Określa, 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/<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 (Przestarzałe) Liczba godzin oczekiwania między utworzeniem 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 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
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? 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

ManagedCassandraManagedServiceIdentity

Nazwa Opis Wartość
typ Typ zasobu. "Brak"
"SystemAssigned"

Microsoft.DocumentDB/cassandraClusters

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2023-11-15'
tożsamość Tożsamość zasobu. ManagedCassandraManagedServiceIdentity
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@2023-11-15"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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

CassandraError

Nazwa Opis Wartość
additionalErrorInfo Dodatkowe informacje o błędzie. struna
kod Kod błędu, który wystąpił. struna
Komunikat Komunikat o błędzie. struna
cel Zasób docelowy błędu. struna

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"
"Ldap"
"Brak"
cassandraAuditLoggingEnabled Czy rejestrowanie inspekcji cassandra jest włączone Bool
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
Dealokowane Określa, 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/<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 (Przestarzałe) Liczba godzin oczekiwania między utworzeniem 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 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
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? 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

ManagedCassandraManagedServiceIdentity

Nazwa Opis Wartość
typ Typ zasobu. "Brak"
"SystemAssigned"

Microsoft.DocumentDB/cassandraClusters

Nazwa Opis Wartość
tożsamość Tożsamość zasobu. ManagedCassandraManagedServiceIdentity
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@2023-11-15"

SeedNode

Nazwa Opis Wartość
ipAddress Adres IP tego węzła inicjowania. struna

Tagi

Nazwa Opis Wartość