Sdílet prostřednictvím

Microsoft.DocumentDB cassandraClusters 2024-08-15

  • Článek

Definice prostředku Bicep

Typ prostředku cassandraClusters je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/cassandraClusters, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2024-08-15' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    authenticationMethod: 'string'
    azureConnectionMethod: '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'
  }
}

Hodnoty vlastností

CassandraError

Jméno Popis Hodnota
additionalErrorInfo Další informace o chybě řetězec
kód Kód chyby, ke které došlo. řetězec
zpráva Zpráva o chybě. řetězec
cíl Cílový prostředek chyby. řetězec

Certifikát

Jméno Popis Hodnota
Pem Veřejný klíč formátovaný PEM řetězec

ClusterResourceProperties

Jméno Popis Hodnota
authenticationMethod Kterou metodu ověřování by Cassandra měla použít k ověřování klientů. Možnost Žádné vypne ověřování, takže by se nemělo používat s výjimkou nouzových situací. Cassandra je výchozí ověřování na základě hesla. Výchozí hodnota je Cassandra. Cassandra
Ldap
None (Žádný)
azureConnectionMethod Jak se připojit ke službám Azure potřebným ke spuštění clusteru None (Žádný)
VPN
cassandraAuditLoggingEnabled Jestli je povolené protokolování auditu Cassandra Bool
cassandraVersion Jakou verzi Cassandra má tento cluster konvergovat ke spuštění (např. 3.11). Po aktualizaci může migrace clusteru na novou verzi nějakou dobu trvat. řetězec
clientCertificates Seznam certifikátů TLS používaných k autorizaci klientů připojujících se ke clusteru Všechna připojení jsou šifrovaná protokolem TLS bez ohledu na to, jestli je klientCertificates nastavený, ale pokud je nastavená klientská certifikáty ClientCertificates, spravovaný cluster Cassandra odmítne všechna připojení, která nemají klientský certifikát TLS, který lze ověřit z jednoho nebo více veřejných certifikátů v této vlastnosti. certifikátu []
clusterNameOverride Pokud potřebujete nastavit vlastnost clusterName v cassandra.yaml na něco kromě názvu prostředku clusteru, nastavte hodnotu, která se má použít pro tuto vlastnost. řetězec
uvolnil Určuje, jestli byl cluster a přidružená datacentra uvolněna. Bool
delegatedManagementSubnetId ID prostředku podsítě, ke které má služba pro správu tohoto clusteru připojené síťové rozhraní. Podsíť musí být směrovatelná na všechny podsítě, které budou delegovány do datových center. ID prostředku musí být ve formátu /subscriptions/<ID předplatného>/resourceGroups/<skupina prostředků>/providers/Microsoft.Network/virtualNetworks/<virtuální síť>/subnets/<podsíť>' řetězec
externalGossipCertificates Seznam certifikátů TLS používaných k autorizaci gossip z nespravovaných datových center Certifikáty TLS všech uzlů v nespravovaných datových centrech musí být ověřitelné pomocí jednoho z certifikátů uvedených v této vlastnosti. certifikátu []
externalSeedNodes Seznam IP adres počátečních uzlů v nespravovaných datových centrech Tyto uzly se přidají do seznamů počátečních uzlů všech spravovaných uzlů. SeedNode[]
hoursBetweenBackups (Zastaralé) Počet hodin čekání mezi zálohováním clusteru Int
initialCassandraAdminPassword Počáteční heslo pro klienty připojující se jako správce ke clusteru Po vytvoření clusteru by se mělo změnit. Vrátí hodnotu null pro get. Toto pole platí pouze v případě, že pole authenticationMethod je Cassandra. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
prometheusEndpoint Název hostitele nebo IP adresa, kde je možné dosáhnout koncového bodu Prometheus obsahujícího data o spravovaných uzlech Cassandra. SeedNode
provisionError Chyba související se zřizováním prostředků CassandraError
provisioningState Stav prostředku v době, kdy byla operace volána. Zrušeno
Vytváření
Odstranění
Chyba
Úspěch
Aktualizace
repairEnabled Mají se v tomto clusteru spouštět automatické opravy? Pokud tuto hodnotu vynecháte, mělo by to platit, pokud nepoužíváte hybridní cluster, ve kterém už provádíte vlastní opravy. Bool
restoreFromBackupId Pokud chcete vytvořit prázdný cluster, vynecháte toto pole nebo ho nastavte na hodnotu null. Pokud chcete obnovit zálohu do nového clusteru, nastavte toto pole na ID prostředku zálohy. řetězec

ManagedCassandraManagedServiceIdentity

Jméno Popis Hodnota
typ Typ prostředku. None (Žádný)
SystemAssigned

Microsoft.DocumentDB/cassandraClusters

Jméno Popis Hodnota
identita Identita prostředku ManagedCassandraManagedServiceIdentity
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 100
Model = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (povinné)
vlastnosti Vlastnosti spravovaného clusteru Cassandra clusterResourceProperties
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

SeedNode

Jméno Popis Hodnota
ipAddress IP adresa tohoto počátečního uzlu. řetězec

Visačky

Jméno Popis Hodnota

Definice prostředku šablony ARM

Typ prostředku cassandraClusters je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/cassandraClusters, přidejte do šablony následující JSON.

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2024-08-15",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "authenticationMethod": "string",
    "azureConnectionMethod": "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"
  }
}

Hodnoty vlastností

CassandraError

Jméno Popis Hodnota
additionalErrorInfo Další informace o chybě řetězec
kód Kód chyby, ke které došlo. řetězec
zpráva Zpráva o chybě. řetězec
cíl Cílový prostředek chyby. řetězec

Certifikát

Jméno Popis Hodnota
Pem Veřejný klíč formátovaný PEM řetězec

ClusterResourceProperties

Jméno Popis Hodnota
authenticationMethod Kterou metodu ověřování by Cassandra měla použít k ověřování klientů. Možnost Žádné vypne ověřování, takže by se nemělo používat s výjimkou nouzových situací. Cassandra je výchozí ověřování na základě hesla. Výchozí hodnota je Cassandra. Cassandra
Ldap
None (Žádný)
azureConnectionMethod Jak se připojit ke službám Azure potřebným ke spuštění clusteru None (Žádný)
VPN
cassandraAuditLoggingEnabled Jestli je povolené protokolování auditu Cassandra Bool
cassandraVersion Jakou verzi Cassandra má tento cluster konvergovat ke spuštění (např. 3.11). Po aktualizaci může migrace clusteru na novou verzi nějakou dobu trvat. řetězec
clientCertificates Seznam certifikátů TLS používaných k autorizaci klientů připojujících se ke clusteru Všechna připojení jsou šifrovaná protokolem TLS bez ohledu na to, jestli je klientCertificates nastavený, ale pokud je nastavená klientská certifikáty ClientCertificates, spravovaný cluster Cassandra odmítne všechna připojení, která nemají klientský certifikát TLS, který lze ověřit z jednoho nebo více veřejných certifikátů v této vlastnosti. certifikátu []
clusterNameOverride Pokud potřebujete nastavit vlastnost clusterName v cassandra.yaml na něco kromě názvu prostředku clusteru, nastavte hodnotu, která se má použít pro tuto vlastnost. řetězec
uvolnil Určuje, jestli byl cluster a přidružená datacentra uvolněna. Bool
delegatedManagementSubnetId ID prostředku podsítě, ke které má služba pro správu tohoto clusteru připojené síťové rozhraní. Podsíť musí být směrovatelná na všechny podsítě, které budou delegovány do datových center. ID prostředku musí být ve formátu /subscriptions/<ID předplatného>/resourceGroups/<skupina prostředků>/providers/Microsoft.Network/virtualNetworks/<virtuální síť>/subnets/<podsíť>' řetězec
externalGossipCertificates Seznam certifikátů TLS používaných k autorizaci gossip z nespravovaných datových center Certifikáty TLS všech uzlů v nespravovaných datových centrech musí být ověřitelné pomocí jednoho z certifikátů uvedených v této vlastnosti. certifikátu []
externalSeedNodes Seznam IP adres počátečních uzlů v nespravovaných datových centrech Tyto uzly se přidají do seznamů počátečních uzlů všech spravovaných uzlů. SeedNode[]
hoursBetweenBackups (Zastaralé) Počet hodin čekání mezi zálohováním clusteru Int
initialCassandraAdminPassword Počáteční heslo pro klienty připojující se jako správce ke clusteru Po vytvoření clusteru by se mělo změnit. Vrátí hodnotu null pro get. Toto pole platí pouze v případě, že pole authenticationMethod je Cassandra. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
prometheusEndpoint Název hostitele nebo IP adresa, kde je možné dosáhnout koncového bodu Prometheus obsahujícího data o spravovaných uzlech Cassandra. SeedNode
provisionError Chyba související se zřizováním prostředků CassandraError
provisioningState Stav prostředku v době, kdy byla operace volána. Zrušeno
Vytváření
Odstranění
Chyba
Úspěch
Aktualizace
repairEnabled Mají se v tomto clusteru spouštět automatické opravy? Pokud tuto hodnotu vynecháte, mělo by to platit, pokud nepoužíváte hybridní cluster, ve kterém už provádíte vlastní opravy. Bool
restoreFromBackupId Pokud chcete vytvořit prázdný cluster, vynecháte toto pole nebo ho nastavte na hodnotu null. Pokud chcete obnovit zálohu do nového clusteru, nastavte toto pole na ID prostředku zálohy. řetězec

ManagedCassandraManagedServiceIdentity

Jméno Popis Hodnota
typ Typ prostředku. None (Žádný)
SystemAssigned

Microsoft.DocumentDB/cassandraClusters

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2024-08-15'
identita Identita prostředku ManagedCassandraManagedServiceIdentity
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 100
Model = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (povinné)
vlastnosti Vlastnosti spravovaného clusteru Cassandra clusterResourceProperties
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.DocumentDB/cassandraClusters

SeedNode

Jméno Popis Hodnota
ipAddress IP adresa tohoto počátečního uzlu. řetězec

Visačky

Jméno Popis Hodnota

Příklady použití

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku cassandraClusters je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/cassandraClusters, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2024-08-15"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authenticationMethod = "string"
      azureConnectionMethod = "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"
    }
  })
}

Hodnoty vlastností

CassandraError

Jméno Popis Hodnota
additionalErrorInfo Další informace o chybě řetězec
kód Kód chyby, ke které došlo. řetězec
zpráva Zpráva o chybě. řetězec
cíl Cílový prostředek chyby. řetězec

Certifikát

Jméno Popis Hodnota
Pem Veřejný klíč formátovaný PEM řetězec

ClusterResourceProperties

Jméno Popis Hodnota
authenticationMethod Kterou metodu ověřování by Cassandra měla použít k ověřování klientů. Možnost Žádné vypne ověřování, takže by se nemělo používat s výjimkou nouzových situací. Cassandra je výchozí ověřování na základě hesla. Výchozí hodnota je Cassandra. Cassandra
Ldap
None (Žádný)
azureConnectionMethod Jak se připojit ke službám Azure potřebným ke spuštění clusteru None (Žádný)
VPN
cassandraAuditLoggingEnabled Jestli je povolené protokolování auditu Cassandra Bool
cassandraVersion Jakou verzi Cassandra má tento cluster konvergovat ke spuštění (např. 3.11). Po aktualizaci může migrace clusteru na novou verzi nějakou dobu trvat. řetězec
clientCertificates Seznam certifikátů TLS používaných k autorizaci klientů připojujících se ke clusteru Všechna připojení jsou šifrovaná protokolem TLS bez ohledu na to, jestli je klientCertificates nastavený, ale pokud je nastavená klientská certifikáty ClientCertificates, spravovaný cluster Cassandra odmítne všechna připojení, která nemají klientský certifikát TLS, který lze ověřit z jednoho nebo více veřejných certifikátů v této vlastnosti. certifikátu []
clusterNameOverride Pokud potřebujete nastavit vlastnost clusterName v cassandra.yaml na něco kromě názvu prostředku clusteru, nastavte hodnotu, která se má použít pro tuto vlastnost. řetězec
uvolnil Určuje, jestli byl cluster a přidružená datacentra uvolněna. Bool
delegatedManagementSubnetId ID prostředku podsítě, ke které má služba pro správu tohoto clusteru připojené síťové rozhraní. Podsíť musí být směrovatelná na všechny podsítě, které budou delegovány do datových center. ID prostředku musí být ve formátu /subscriptions/<ID předplatného>/resourceGroups/<skupina prostředků>/providers/Microsoft.Network/virtualNetworks/<virtuální síť>/subnets/<podsíť>' řetězec
externalGossipCertificates Seznam certifikátů TLS používaných k autorizaci gossip z nespravovaných datových center Certifikáty TLS všech uzlů v nespravovaných datových centrech musí být ověřitelné pomocí jednoho z certifikátů uvedených v této vlastnosti. certifikátu []
externalSeedNodes Seznam IP adres počátečních uzlů v nespravovaných datových centrech Tyto uzly se přidají do seznamů počátečních uzlů všech spravovaných uzlů. SeedNode[]
hoursBetweenBackups (Zastaralé) Počet hodin čekání mezi zálohováním clusteru Int
initialCassandraAdminPassword Počáteční heslo pro klienty připojující se jako správce ke clusteru Po vytvoření clusteru by se mělo změnit. Vrátí hodnotu null pro get. Toto pole platí pouze v případě, že pole authenticationMethod je Cassandra. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
prometheusEndpoint Název hostitele nebo IP adresa, kde je možné dosáhnout koncového bodu Prometheus obsahujícího data o spravovaných uzlech Cassandra. SeedNode
provisionError Chyba související se zřizováním prostředků CassandraError
provisioningState Stav prostředku v době, kdy byla operace volána. Zrušeno
Vytváření
Odstranění
Chyba
Úspěch
Aktualizace
repairEnabled Mají se v tomto clusteru spouštět automatické opravy? Pokud tuto hodnotu vynecháte, mělo by to platit, pokud nepoužíváte hybridní cluster, ve kterém už provádíte vlastní opravy. Bool
restoreFromBackupId Pokud chcete vytvořit prázdný cluster, vynecháte toto pole nebo ho nastavte na hodnotu null. Pokud chcete obnovit zálohu do nového clusteru, nastavte toto pole na ID prostředku zálohy. řetězec

ManagedCassandraManagedServiceIdentity

Jméno Popis Hodnota
typ Typ prostředku. None (Žádný)
SystemAssigned

Microsoft.DocumentDB/cassandraClusters

Jméno Popis Hodnota
identita Identita prostředku ManagedCassandraManagedServiceIdentity
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 100
Model = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (povinné)
vlastnosti Vlastnosti spravovaného clusteru Cassandra clusterResourceProperties
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku Microsoft.DocumentDB/cassandraClusters@2024-08-15

SeedNode

Jméno Popis Hodnota
ipAddress IP adresa tohoto počátečního uzlu. řetězec

Visačky

Jméno Popis Hodnota