Microsoft.DocumentDB cassandraClusters 2023-03-01-preview

  • 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 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-03-01-preview' = {
  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'
    }
    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ą być używane w wyświetlaniu i grupowaniu tego zasobu (w grupach 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 ustawione 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óra metoda uwierzytelniania Cassandra powinna użyć 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". "Ldap" jest w wersji zapoznawczej. "Cassandra"
"Ldap"
"Brak"
cassandraAuditLoggingEnabled Czy rejestrowanie inspekcji Cassandra jest włączone bool
cassandraVersion Która wersja systemu Cassandra powinna być zbieżna z uruchomionym klastrem (np. 3.11). Po zaktualizowaniu klastra migracja do nowej wersji może zająć trochę czasu. ciąg
Clientcertificates Lista certyfikatów TLS używanych do autoryzowania klientów łączących się z klastrem. Wszystkie połączenia są szyfrowane za pomocą protokołu TLS niezależnie od tego, czy klientCertificates 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. Certyfikat[]
clusterNameOverride Jeśli musisz ustawić właściwość clusterName w pliku cassandra.yaml na coś oprócz nazwy zasobu klastra, ustaw wartość do użycia w tej właściwości. ciąg
Dealokowane Czy klaster i skojarzone centra danych zostały cofnięto przydział. 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 Liczba godzin oczekiwania między wykonaniem 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 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
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

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 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-03-01-preview",
  "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"
    },
    "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-03-01-preview"
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ą być używane w wyświetlaniu i grupowaniu tego zasobu (w grupach 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 ustawione 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óra metoda uwierzytelniania Cassandra powinna użyć 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". "Ldap" jest w wersji zapoznawczej. "Cassandra"
"Ldap"
"Brak"
cassandraAuditLoggingEnabled Czy rejestrowanie inspekcji Cassandra jest włączone bool
cassandraVersion Która wersja systemu Cassandra powinna być zbieżna z uruchomionym klastrem (np. 3.11). Po zaktualizowaniu klastra migracja do nowej wersji może zająć trochę czasu. ciąg
Clientcertificates Lista certyfikatów TLS używanych do autoryzowania klientów łączących się z klastrem. Wszystkie połączenia są szyfrowane za pomocą protokołu TLS niezależnie od tego, czy klientCertificates 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. Certyfikat[]
clusterNameOverride Jeśli musisz ustawić właściwość clusterName w pliku cassandra.yaml na coś oprócz nazwy zasobu klastra, ustaw wartość do użycia w tej właściwości. ciąg
Dealokowane Czy klaster i skojarzone centra danych zostały cofnięto przydział. 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 Liczba godzin oczekiwania między wykonaniem 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 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
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

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 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-03-01-preview"
  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"
      }
      provisioningState = "string"
      repairEnabled = bool
      restoreFromBackupId = "string"
    }
  })
}

Wartości właściwości

cassandraClusters

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/cassandraClusters@2023-03-01-preview"
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". "Ldap" jest w wersji zapoznawczej. "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 Liczba godzin oczekiwania między wykonaniem 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 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
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