Microsoft.DocumentDB cassandraClusters 2023-11-15

  • Artikel

Bicep-resursdefinition

Resurstypen cassandraClusters kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/cassandraClusters-resurs lägger du till följande Bicep i mallen.

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'
  }
}

Egenskapsvärden

cassandraClusters

Name Beskrivning Värde
name Resursnamnet sträng (krävs)
location Platsen för den resursgrupp som resursen tillhör. sträng
tags Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". Ordlista med taggnamn och värden. Se Taggar i mallar
identity Identitet för resursen. ManagedCassandraManagedServiceIdentity
properties Egenskaper för ett hanterat Cassandra-kluster. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Name Beskrivning Värde
typ Resurstypen. "Ingen"
"SystemTilldelade"

ClusterResourceProperties

Name Beskrivning Värde
authenticationMethod Vilken autentiseringsmetod Cassandra ska använda för att autentisera klienter. "Ingen" inaktiverar autentisering, så bör inte användas förutom i nödsituationer. Cassandra är standardlösenordsbaserad autentisering. Standardvärdet är Cassandra. "Cassandra"
"Ldap"
"Ingen"
cassandraAuditLoggingEnabled Om Cassandra-granskningsloggning är aktiverat boolesk
cassandraVersion Vilken version av Cassandra ska klustret konvergera till att köras (t.ex. 3.11). När klustret uppdateras kan det ta lite tid att migrera till den nya versionen. sträng
clientCertificates Lista över TLS-certifikat som används för att auktorisera klienter som ansluter till klustret. Alla anslutningar är TLS-krypterade oavsett om clientCertificates har angetts eller inte, men om clientCertificates har angetts avvisar det hanterade Cassandra-klustret alla anslutningar som inte har ett TLS-klientcertifikat som kan verifieras från ett eller flera av de offentliga certifikaten i den här egenskapen. Certifikat[]
clusterNameOverride Om du behöver ange egenskapen clusterName i cassandra.yaml till något utöver klustrets resursnamn anger du det värde som ska användas för den här egenskapen. sträng
frigjord Om klustret och associerade datacenter har frigjorts. boolesk
delegatedManagementSubnetId Resurs-ID för ett undernät som klustrets hanteringstjänst ska ha sitt nätverksgränssnitt kopplat till. Undernätet måste kunna dirigeras till alla undernät som ska delegeras till datacenter. Resurs-ID:t måste vara i formatet "/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}" sträng
externalGossipCertificates Lista över TLS-certifikat som används för att auktorisera skvaller från ohanterade datacenter. TLS-certifikaten för alla noder i ohanterade datacenter måste kunna verifieras med något av certifikaten i den här egenskapen. Certifikat[]
externalSeedNodes Lista över IP-adresser för startnoder i ohanterade datacenter. Dessa läggs till i listan med startnoder för alla hanterade noder. SeedNode[]
hoursBetweenBackups (Inaktuell) Antal timmar att vänta mellan säkerhetskopieringen av klustret. int
initialCassandraAdminPassword Initialt lösenord för klienter som ansluter som administratör till klustret. Bör ändras när klustret har skapats. Returnerar null på GET. Det här fältet gäller endast när fältet authenticationMethod är "Cassandra". sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
prometheusEndpoint Värdnamn eller IP-adress där Prometheus-slutpunkten som innehåller data om de hanterade Cassandra-noderna kan nås. SeedNode
provisionError Fel som rör resursetablering. CassandraError
provisioningState Status för resursen vid den tidpunkt då åtgärden anropades. "Avbruten"
"Skapar"
"Ta bort"
"Misslyckades"
"Lyckades"
"Uppdatera"
repairEnabled Ska automatiska reparationer köras på det här klustret? Om detta utelämnas är detta sant och bör förbli sant om du inte kör ett hybridkluster där du redan utför dina egna reparationer. boolesk
restoreFromBackupId Om du vill skapa ett tomt kluster utelämnar du det här fältet eller ställer in det på null. Om du vill återställa en säkerhetskopia till ett nytt kluster anger du det här fältet till resurs-ID:t för säkerhetskopian. sträng

Certifikat

Name Beskrivning Värde
Pem PEM-formaterad offentlig nyckel. sträng

SeedNode

Name Beskrivning Värde
Ip IP-adressen för den här startnoden. sträng

CassandraError

Name Beskrivning Värde
additionalErrorInfo Ytterligare information om felet. sträng
kod Felkoden som inträffade. sträng
meddelande Meddelandet om felet. sträng
Mål Målresursen för felet. sträng

Resursdefinition för ARM-mall

Resurstypen cassandraClusters kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/cassandraClusters-resurs lägger du till följande JSON i mallen.

{
  "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"
  }
}

Egenskapsvärden

cassandraClusters

Name Beskrivning Värde
typ Resurstypen "Microsoft.DocumentDB/cassandraClusters"
apiVersion Resurs-API-versionen '2023-11-15'
name Resursnamnet sträng (krävs)
location Platsen för den resursgrupp som resursen tillhör. sträng
tags Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". Ordlista med taggnamn och värden. Se Taggar i mallar
identity Identitet för resursen. ManagedCassandraManagedServiceIdentity
properties Egenskaper för ett hanterat Cassandra-kluster. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Name Beskrivning Värde
typ Resurstypen. "Ingen"
"SystemTilldelade"

ClusterResourceProperties

Name Beskrivning Värde
authenticationMethod Vilken autentiseringsmetod Cassandra ska använda för att autentisera klienter. "Ingen" inaktiverar autentisering, så bör inte användas förutom i nödsituationer. Cassandra är standardlösenordsbaserad autentisering. Standardvärdet är Cassandra. "Cassandra"
"Ldap"
"Ingen"
cassandraAuditLoggingEnabled Om Cassandra-granskningsloggning är aktiverat boolesk
cassandraVersion Vilken version av Cassandra ska klustret konvergera till att köras (t.ex. 3.11). När klustret uppdateras kan det ta lite tid att migrera till den nya versionen. sträng
clientCertificates Lista över TLS-certifikat som används för att auktorisera klienter som ansluter till klustret. Alla anslutningar är TLS-krypterade oavsett om clientCertificates har angetts eller inte, men om clientCertificates har angetts avvisar det hanterade Cassandra-klustret alla anslutningar som inte har ett TLS-klientcertifikat som kan verifieras från ett eller flera av de offentliga certifikaten i den här egenskapen. Certifikat[]
clusterNameOverride Om du behöver ange egenskapen clusterName i cassandra.yaml till något utöver klustrets resursnamn anger du det värde som ska användas för den här egenskapen. sträng
frigjord Om klustret och associerade datacenter har frigjorts. boolesk
delegatedManagementSubnetId Resurs-ID för ett undernät som klustrets hanteringstjänst ska ha sitt nätverksgränssnitt kopplat till. Undernätet måste kunna dirigeras till alla undernät som ska delegeras till datacenter. Resurs-ID:t måste vara i formatet "/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}" sträng
externalGossipCertificates Lista över TLS-certifikat som används för att auktorisera skvaller från ohanterade datacenter. TLS-certifikaten för alla noder i ohanterade datacenter måste kunna verifieras med något av certifikaten i den här egenskapen. Certifikat[]
externalSeedNodes Lista över IP-adresser för startnoder i ohanterade datacenter. Dessa läggs till i listan med startnoder för alla hanterade noder. SeedNode[]
hoursBetweenBackups (Inaktuell) Antal timmar att vänta mellan säkerhetskopieringen av klustret. int
initialCassandraAdminPassword Initialt lösenord för klienter som ansluter som administratör till klustret. Bör ändras när klustret har skapats. Returnerar null på GET. Det här fältet gäller endast när fältet authenticationMethod är "Cassandra". sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
prometheusEndpoint Värdnamn eller IP-adress där Prometheus-slutpunkten som innehåller data om de hanterade Cassandra-noderna kan nås. SeedNode
provisionError Fel som rör resursetablering. CassandraError
provisioningState Status för resursen vid den tidpunkt då åtgärden anropades. "Avbruten"
"Skapar"
"Ta bort"
"Misslyckades"
"Lyckades"
"Uppdatera"
repairEnabled Ska automatiska reparationer köras på det här klustret? Om detta utelämnas är detta sant och bör förbli sant om du inte kör ett hybridkluster där du redan utför dina egna reparationer. boolesk
restoreFromBackupId Om du vill skapa ett tomt kluster utelämnar du det här fältet eller ställer in det på null. Om du vill återställa en säkerhetskopia till ett nytt kluster anger du det här fältet till resurs-ID:t för säkerhetskopian. sträng

Certifikat

Name Beskrivning Värde
Pem PEM-formaterad offentlig nyckel. sträng

SeedNode

Name Beskrivning Värde
Ip IP-adressen för den här startnoden. sträng

CassandraError

Name Beskrivning Värde
additionalErrorInfo Ytterligare information om felet. sträng
kod Felkoden som inträffade. sträng
meddelande Meddelandet om felet. sträng
Mål Målresursen för felet. sträng

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen cassandraClusters kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/cassandraClusters-resurs lägger du till följande Terraform i mallen.

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"
    }
  })
}

Egenskapsvärden

cassandraClusters

Name Beskrivning Värde
typ Resurstypen "Microsoft.DocumentDB/cassandraClusters@2023-11-15"
name Resursnamnet sträng (krävs)
location Platsen för den resursgrupp som resursen tillhör. sträng
parent_id Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen. sträng (krävs)
tags Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". Ordlista med taggnamn och värden.
identity Identitet för resursen. ManagedCassandraManagedServiceIdentity
properties Egenskaper för ett hanterat Cassandra-kluster. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Name Beskrivning Värde
typ Resurstypen. "SystemTilldelade"

ClusterResourceProperties

Name Beskrivning Värde
authenticationMethod Vilken autentiseringsmetod Cassandra ska använda för att autentisera klienter. "Ingen" inaktiverar autentisering, så bör inte användas förutom i nödsituationer. Cassandra är standardlösenordsbaserad autentisering. Standardvärdet är Cassandra. "Cassandra"
"Ldap"
"Ingen"
cassandraAuditLoggingEnabled Om Cassandra-granskningsloggning är aktiverat boolesk
cassandraVersion Vilken version av Cassandra ska klustret konvergera till att köras (t.ex. 3.11). När klustret uppdateras kan det ta lite tid att migrera till den nya versionen. sträng
clientCertificates Lista över TLS-certifikat som används för att auktorisera klienter som ansluter till klustret. Alla anslutningar är TLS-krypterade oavsett om clientCertificates har angetts eller inte, men om clientCertificates har angetts avvisar det hanterade Cassandra-klustret alla anslutningar som inte har ett TLS-klientcertifikat som kan verifieras från ett eller flera av de offentliga certifikaten i den här egenskapen. Certifikat[]
clusterNameOverride Om du behöver ange egenskapen clusterName i cassandra.yaml till något utöver klustrets resursnamn anger du det värde som ska användas för den här egenskapen. sträng
frigjord Om klustret och associerade datacenter har frigjorts. boolesk
delegatedManagementSubnetId Resurs-ID för ett undernät som klustrets hanteringstjänst ska ha sitt nätverksgränssnitt kopplat till. Undernätet måste kunna dirigeras till alla undernät som ska delegeras till datacenter. Resurs-ID:t måste vara i formatet "/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}" sträng
externalGossipCertificates Lista över TLS-certifikat som används för att auktorisera skvaller från ohanterade datacenter. TLS-certifikaten för alla noder i ohanterade datacenter måste kunna verifieras med något av certifikaten i den här egenskapen. Certifikat[]
externalSeedNodes Lista över IP-adresser för startnoder i ohanterade datacenter. Dessa läggs till i listan med startnoder för alla hanterade noder. SeedNode[]
hoursBetweenBackups (Inaktuell) Antal timmar att vänta mellan säkerhetskopieringen av klustret. int
initialCassandraAdminPassword Initialt lösenord för klienter som ansluter som administratör till klustret. Bör ändras när klustret har skapats. Returnerar null på GET. Det här fältet gäller endast när fältet authenticationMethod är "Cassandra". sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
prometheusEndpoint Värdnamn eller IP-adress där Prometheus-slutpunkten som innehåller data om de hanterade Cassandra-noderna kan nås. SeedNode
provisionError Fel som rör resursetablering. CassandraError
provisioningState Status för resursen vid den tidpunkt då åtgärden anropades. "Avbruten"
"Skapa"
"Ta bort"
"Misslyckades"
"Lyckades"
"Uppdatera"
repairEnabled Ska automatiska reparationer köras på det här klustret? Om detta utelämnas är detta sant och bör förbli sant om du inte kör ett hybridkluster där du redan utför dina egna reparationer. boolesk
restoreFromBackupId Om du vill skapa ett tomt kluster utelämnar du det här fältet eller ställer in det på null. Om du vill återställa en säkerhetskopia till ett nytt kluster anger du det här fältet till resurs-ID:t för säkerhetskopian. sträng

Certifikat

Name Beskrivning Värde
Pem PEM-formaterad offentlig nyckel. sträng

SeedNode

Name Beskrivning Värde
Ip IP-adressen för den här startnoden. sträng

CassandraError

Name Beskrivning Värde
additionalErrorInfo Ytterligare information om felet. sträng
kod Felkoden som inträffade. sträng
meddelande Meddelandet om felet. sträng
Mål Målresursen för felet. sträng