Microsoft.DocumentDB cassandraClusters 2023-09-15

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp cassandraClusters kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/cassandraClusters-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2023-09-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'
  }
}

Eigenschaftswerte

cassandraClusters

Name BESCHREIBUNG Wert
name Der Ressourcenname Zeichenfolge (erforderlich)
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Identität Identität für die Ressource. ManagedCassandraManagedServiceIdentity
properties Eigenschaften eines verwalteten Cassandra-Clusters. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Name BESCHREIBUNG Wert
type Der Typ der Ressource. "Keine"
"SystemAssigned"

ClusterResourceProperties

Name BESCHREIBUNG Wert
authenticationMethod Welche Authentifizierungsmethode Cassandra verwenden sollte, um Clients zu authentifizieren. "Keine" deaktiviert die Authentifizierung. Daher sollte nur in Notfällen verwendet werden. "Cassandra" ist die kennwortbasierte Standardauthentifizierung. Der Standardwert ist "Cassandra". Cassandra
"Ldap"
"Keine"
cassandraAuditLoggingEnabled Ob die Cassandra-Überwachungsprotokollierung aktiviert ist bool
cassandraVersion Welche Version von Cassandra sollte dieser Cluster zur Ausführung konvergieren (z. B. 3.11). Nach der Aktualisierung kann die Migration des Clusters zur neuen Version einige Zeit in Anspruch nehmen. Zeichenfolge
clientCertificates Liste der TLS-Zertifikate, die zum Autorisieren von Clients verwendet werden, die eine Verbindung mit dem Cluster herstellen. Alle Verbindungen sind TLS-verschlüsselt, unabhängig davon, ob clientCertificates festgelegt ist oder nicht, aber wenn clientCertificates festgelegt ist, lehnt der verwaltete Cassandra-Cluster alle Verbindungen ab, die nicht ein TLS-Clientzertifikat enthalten, das anhand eines oder mehrerer der öffentlichen Zertifikate in dieser Eigenschaft überprüft werden kann. Zertifikat[]
clusterNameOverride Wenn Sie die clusterName-Eigenschaft in cassandra.yaml auf etwas neben dem Ressourcennamen des Clusters festlegen müssen, legen Sie den Wert fest, der für diese Eigenschaft verwendet werden soll. Zeichenfolge
Freigegeben Gibt an, ob der Cluster und die zugehörigen Rechenzentren zugeordnet wurden. bool
delegatedManagementSubnetId Ressourcen-ID eines Subnetzes, an das der Verwaltungsdienst dieses Clusters seine Netzwerkschnittstelle angefügt haben sollte. Das Subnetz muss für alle Subnetze routingfähig sein, die an Rechenzentren delegiert werden. Die Ressourcen-ID muss das Format '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' haben. Zeichenfolge
externalGossipCertificates Liste der TLS-Zertifikate, die zum Autorisieren von Gossip aus nicht verwalteten Rechenzentren verwendet werden. Die TLS-Zertifikate aller Knoten in nicht verwalteten Rechenzentren müssen mithilfe eines der in dieser Eigenschaft bereitgestellten Zertifikate überprüfbar sein. Zertifikat[]
externalSeedNodes Liste der IP-Adressen von Seedknoten in nicht verwalteten Rechenzentren. Diese werden den Seedknotenlisten aller verwalteten Knoten hinzugefügt. SeedNode[]
StundenBetweenBackups (veraltet) Die Anzahl der Stunden, die zwischen dem Erstellen einer Sicherung des Clusters gewartet werden müssen. INT
initialCassandraAdminPassword Anfangskennwort für Clients, die als Administrator mit dem Cluster verbunden sind. Sollte nach der Clustererstellung geändert werden. Gibt NULL für GET zurück. Dieses Feld gilt nur, wenn das Feld authenticationMethod "Cassandra" lautet. Zeichenfolge

Einschränkungen:
Vertraulicher Wert. Übergeben Sie als sicheren Parameter.
prometheusEndpoint Hostname oder IP-Adresse, an der der Prometheus-Endpunkt mit Daten zu den verwalteten Cassandra-Knoten erreicht werden kann. SeedNode
provisionError Fehler im Zusammenhang mit der Ressourcenbereitstellung. CassandraError
provisioningState Der Status der Ressource zum Zeitpunkt des Aufrufs des Vorgangs. "Abgebrochen"
"Erstellen"
"Löschen"
"Fehler"
"Erfolgreich"
"Aktualisieren"
repairEnabled Sollten automatische Reparaturen auf diesem Cluster ausgeführt werden? Wenn nicht angegeben, ist dies wahr und sollte wahr bleiben, es sei denn, Sie führen einen Hybridcluster aus, in dem Sie bereits Ihre eigenen Reparaturen durchführen. bool
restoreFromBackupId Um einen leeren Cluster zu erstellen, lassen Sie dieses Feld aus, oder legen Sie es auf NULL fest. Um eine Sicherung in einem neuen Cluster wiederherzustellen, legen Sie dieses Feld auf die Ressourcen-ID der Sicherung fest. Zeichenfolge

Zertifikat

Name BESCHREIBUNG Wert
Pem PEM-formatierter öffentlicher Schlüssel. Zeichenfolge

SeedNode

Name BESCHREIBUNG Wert
ipAddress IP-Adresse dieses Seedknotens. Zeichenfolge

CassandraError

Name BESCHREIBUNG Wert
additionalErrorInfo Weitere Informationen zum Fehler. Zeichenfolge
code Der Fehlercode, der aufgetreten ist. Zeichenfolge
message Die Meldung des Fehlers. Zeichenfolge
target Die Zielressource des Fehlers. Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp cassandraClusters kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/cassandraClusters-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2023-09-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"
  }
}

Eigenschaftswerte

cassandraClusters

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.DocumentDB/cassandraClusters"
apiVersion Die Ressourcen-API-Version '2023-09-15'
name Der Ressourcenname Zeichenfolge (erforderlich)
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Identität Identität für die Ressource. ManagedCassandraManagedServiceIdentity
properties Eigenschaften eines verwalteten Cassandra-Clusters. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Name BESCHREIBUNG Wert
type Der Typ der Ressource. "Keine"
"SystemAssigned"

ClusterResourceProperties

Name BESCHREIBUNG Wert
authenticationMethod Welche Authentifizierungsmethode Cassandra verwenden sollte, um Clients zu authentifizieren. "Keine" deaktiviert die Authentifizierung. Daher sollte nur in Notfällen verwendet werden. "Cassandra" ist die kennwortbasierte Standardauthentifizierung. Der Standardwert ist "Cassandra". Cassandra
"Ldap"
"Keine"
cassandraAuditLoggingEnabled Ob die Cassandra-Überwachungsprotokollierung aktiviert ist bool
cassandraVersion Welche Version von Cassandra sollte dieser Cluster zur Ausführung konvergieren (z. B. 3.11). Nach der Aktualisierung kann die Migration des Clusters zur neuen Version einige Zeit in Anspruch nehmen. Zeichenfolge
clientCertificates Liste der TLS-Zertifikate, die zum Autorisieren von Clients verwendet werden, die eine Verbindung mit dem Cluster herstellen. Alle Verbindungen sind TLS-verschlüsselt, unabhängig davon, ob clientCertificates festgelegt ist oder nicht, aber wenn clientCertificates festgelegt ist, lehnt der verwaltete Cassandra-Cluster alle Verbindungen ab, die nicht ein TLS-Clientzertifikat enthalten, das anhand eines oder mehrerer der öffentlichen Zertifikate in dieser Eigenschaft überprüft werden kann. Zertifikat[]
clusterNameOverride Wenn Sie die clusterName-Eigenschaft in cassandra.yaml auf etwas neben dem Ressourcennamen des Clusters festlegen müssen, legen Sie den Wert fest, der für diese Eigenschaft verwendet werden soll. Zeichenfolge
Freigegeben Gibt an, ob der Cluster und die zugehörigen Rechenzentren zugeordnet wurden. bool
delegatedManagementSubnetId Ressourcen-ID eines Subnetzes, an das der Verwaltungsdienst dieses Clusters seine Netzwerkschnittstelle angefügt haben sollte. Das Subnetz muss für alle Subnetze routingfähig sein, die an Rechenzentren delegiert werden. Die Ressourcen-ID muss das Format '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' haben. Zeichenfolge
externalGossipCertificates Liste der TLS-Zertifikate, die zum Autorisieren von Gossip aus nicht verwalteten Rechenzentren verwendet werden. Die TLS-Zertifikate aller Knoten in nicht verwalteten Rechenzentren müssen mithilfe eines der in dieser Eigenschaft bereitgestellten Zertifikate überprüfbar sein. Zertifikat[]
externalSeedNodes Liste der IP-Adressen von Seedknoten in nicht verwalteten Rechenzentren. Diese werden den Seedknotenlisten aller verwalteten Knoten hinzugefügt. SeedNode[]
StundenBetweenBackups (veraltet) Die Anzahl der Stunden, die zwischen dem Erstellen einer Sicherung des Clusters gewartet werden müssen. INT
initialCassandraAdminPassword Anfangskennwort für Clients, die als Administrator mit dem Cluster verbunden sind. Sollte nach der Clustererstellung geändert werden. Gibt NULL für GET zurück. Dieses Feld gilt nur, wenn das Feld authenticationMethod "Cassandra" lautet. Zeichenfolge

Einschränkungen:
Vertraulicher Wert. Übergeben Sie als sicheren Parameter.
prometheusEndpoint Hostname oder IP-Adresse, an der der Prometheus-Endpunkt mit Daten zu den verwalteten Cassandra-Knoten erreicht werden kann. SeedNode
provisionError Fehler im Zusammenhang mit der Ressourcenbereitstellung. CassandraError
provisioningState Der Status der Ressource zum Zeitpunkt des Aufrufs des Vorgangs. "Abgebrochen"
"Erstellen"
"Löschen"
"Fehler"
"Erfolgreich"
"Aktualisieren"
repairEnabled Sollten automatische Reparaturen auf diesem Cluster ausgeführt werden? Wenn nicht angegeben, ist dies wahr und sollte wahr bleiben, es sei denn, Sie führen einen Hybridcluster aus, in dem Sie bereits Ihre eigenen Reparaturen durchführen. bool
restoreFromBackupId Um einen leeren Cluster zu erstellen, lassen Sie dieses Feld aus, oder legen Sie es auf NULL fest. Um eine Sicherung in einem neuen Cluster wiederherzustellen, legen Sie dieses Feld auf die Ressourcen-ID der Sicherung fest. Zeichenfolge

Zertifikat

Name BESCHREIBUNG Wert
Pem Öffentlicher Schlüssel im PEM-Format. Zeichenfolge

SeedNode

Name BESCHREIBUNG Wert
ipAddress DIE IP-Adresse dieses Startknotens. Zeichenfolge

CassandraError

Name BESCHREIBUNG Wert
additionalErrorInfo Weitere Informationen zum Fehler. Zeichenfolge
code Der Code des aufgetretenen Fehlers. Zeichenfolge
message Die Meldung des Fehlers. Zeichenfolge
target Die Zielressource des Fehlers. Zeichenfolge

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp cassandraClusters kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/cassandraClusters-Ressource zu erstellen, fügen Sie Der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2023-09-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"
    }
  })
}

Eigenschaftswerte

cassandraClusters

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.DocumentDB/cassandraClusters@2023-09-15"
name Der Ressourcenname Zeichenfolge (erforderlich)
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
parent_id Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. Zeichenfolge (erforderlich)
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Beispielsweise ist die Standardumgebung für einen Vorlagentyp auf "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte.
Identität Identität für die Ressource. ManagedCassandraManagedServiceIdentity
properties Eigenschaften eines verwalteten Cassandra-Clusters. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Name BESCHREIBUNG Wert
type Der Typ der Ressource. "SystemAssigned"

ClusterResourceProperties

Name BESCHREIBUNG Wert
authenticationMethod Welche Authentifizierungsmethode Cassandra verwenden soll, um Clients zu authentifizieren. "Keine" deaktiviert die Authentifizierung. Daher sollte nur in Notfällen verwendet werden. "Cassandra" ist die standardkennwortbasierte Authentifizierung. Der Standardwert ist "Cassandra". "Cassandra"
"Ldap"
"None"
cassandraAuditLoggingEnabled Ob die Cassandra-Überwachungsprotokollierung aktiviert ist bool
cassandraVersion Welche Version von Cassandra sollte dieser Cluster zur Ausführung konvergieren (z. B. 3.11). Nach der Aktualisierung kann die Migration des Clusters zur neuen Version einige Zeit in Anspruch nehmen. Zeichenfolge
clientCertificates Liste der TLS-Zertifikate, die zum Autorisieren von Clients verwendet werden, die eine Verbindung mit dem Cluster herstellen. Alle Verbindungen sind TLS-verschlüsselt, unabhängig davon, ob clientCertificates festgelegt ist. Wenn jedoch clientCertificates festgelegt ist, lehnt der verwaltete Cassandra-Cluster alle Verbindungen ab, die kein TLS-Clientzertifikat enthalten, das anhand eines oder mehrerer der öffentlichen Zertifikate in dieser Eigenschaft überprüft werden kann. Zertifikat[]
clusterNameOverride Wenn Sie die clusterName-Eigenschaft in cassandra.yaml auf einen Anderen als den Ressourcennamen des Clusters festlegen müssen, legen Sie den Wert fest, der für diese Eigenschaft verwendet werden soll. Zeichenfolge
Freigegeben Gibt an, ob die Zuordnung des Clusters und der zugehörigen Rechenzentren aufgehoben wurde. bool
delegatedManagementSubnetId Ressourcen-ID eines Subnetzes, an das der Verwaltungsdienst dieses Clusters seine Netzwerkschnittstelle angefügt sein sollte. Das Subnetz muss an alle Subnetze routingfähig sein, die an Rechenzentren delegiert werden. Die Ressourcen-ID muss im Format "/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}" vorliegen. Zeichenfolge
externalGossipCertificates Liste der TLS-Zertifikate, die zum Autorisieren von Gossips aus nicht verwalteten Rechenzentren verwendet werden. Die TLS-Zertifikate aller Knoten in nicht verwalteten Rechenzentren müssen mit einem der in dieser Eigenschaft bereitgestellten Zertifikate überprüfbar sein. Zertifikat[]
externalSeedNodes Liste der IP-Adressen von Startknoten in nicht verwalteten Rechenzentren. Diese werden den Startknotenlisten aller verwalteten Knoten hinzugefügt. SeedNode[]
stundenBetweenBackups (Veraltet) Anzahl der Stunden, die zwischen dem Erstellen einer Sicherung des Clusters gewartet werden sollen. INT
initialCassandraAdminPassword Anfängliches Kennwort für Clients, die als Administrator eine Verbindung mit dem Cluster herstellen. Sollte nach der Clustererstellung geändert werden. Gibt NULL für GET zurück. Dieses Feld gilt nur, wenn das Feld authenticationMethod den Wert "Cassandra" hat. Zeichenfolge

Einschränkungen:
Vertraulicher Wert. Übergeben Sie als sicheren Parameter.
prometheusEndpoint Hostname oder IP-Adresse, an der der Prometheus-Endpunkt mit Daten zu den verwalteten Cassandra-Knoten erreicht werden kann. SeedNode
provisionError Fehler im Zusammenhang mit der Ressourcenbereitstellung. CassandraError
provisioningState Der Status der Ressource zum Zeitpunkt des Aufrufs des Vorgangs. "Abgebrochen"
"Erstellen"
"Löschen"
"Fehler"
"Erfolgreich"
"Aktualisieren"
repairEnabled Sollten automatische Reparaturen in diesem Cluster ausgeführt werden? Wenn nicht angegeben, ist dies wahr und sollte wahr bleiben, es sei denn, Sie führen einen Hybridcluster aus, in dem Sie bereits Ihre eigenen Reparaturen durchführen. bool
restoreFromBackupId Um einen leeren Cluster zu erstellen, lassen Sie dieses Feld aus, oder legen Sie es auf NULL fest. Um eine Sicherung in einem neuen Cluster wiederherzustellen, legen Sie dieses Feld auf die Ressourcen-ID der Sicherung fest. Zeichenfolge

Zertifikat

Name BESCHREIBUNG Wert
Pem Öffentlicher Schlüssel im PEM-Format. Zeichenfolge

SeedNode

Name BESCHREIBUNG Wert
ipAddress DIE IP-Adresse dieses Startknotens. Zeichenfolge

CassandraError

Name BESCHREIBUNG Wert
additionalErrorInfo Weitere Informationen zum Fehler. Zeichenfolge
code Der Code des aufgetretenen Fehlers. Zeichenfolge
message Die Meldung des Fehlers. Zeichenfolge
target Die Zielressource des Fehlers. Zeichenfolge