Share via

Microsoft.DocumentDB cassandraClusters 2023-03-15

  • Článek

Definice prostředku Bicep

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

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@2023-03-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'
  }
}

Hodnoty vlastností

cassandraClusters

Název Description Hodnota
name Název prostředku string (povinné)
location Umístění skupiny prostředků, do které prostředek patří. řetězec
tags Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč, který nesmí být delší než 128 znaků a hodnota nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: Cassandra. Aktuální hodnoty defaultExperience také zahrnují "Table", "Graph", "DocumentDB" a "MongoDB". Slovník názvů a hodnot značek. Zobrazit značky v šablonách
identity Identita prostředku. ManagedCassandraManagedServiceIdentity
properties Vlastnosti spravovaného clusteru Cassandra ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Název Description Hodnota
typ Typ prostředku. 'Žádný'
'SystemAssigned'

ClusterResourceProperties

Název Description 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
'Žádný'
cassandraAuditLoggingEnabled Jestli je povolené protokolování auditu Cassandra bool
cassandraVersion Která verze Cassandry by měla 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 zašifrovaná protokolem TLS bez ohledu na to, jestli jsou nastaveny certifikáty clientCertificates, ale pokud je nastavená možnost clientCertificates, spravovaný cluster Cassandra odmítne všechna připojení bez certifikátu klienta TLS, který je možné ověřit z jednoho nebo více veřejných certifikátů v této vlastnosti. Certifikát[]
clusterNameOverride Pokud potřebujete nastavit vlastnost clusterName v souboru cassandra.yaml na něco kromě názvu prostředku clusteru, nastavte hodnotu, která se má použít pro tuto vlastnost. řetězec
Navrácen Určuje, jestli došlo k uvolnění clusteru a přidružených datových center. bool
delegatedManagementSubnetId ID prostředku podsítě, ke které má mít služba pro správu tohoto clusteru připojené síťové rozhraní. Podsíť musí být směrovatelná do všech 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/{subnet}. ř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ů poskytovaných v této vlastnosti. Certifikát[]
externalSeedNodes Seznam IP adres počátečních uzlů v nespravovaných datových centrech Ty se přidají do seznamu počátečních uzlů všech spravovaných uzlů. SeedNode[]
hoursBetweenBackups (Zastaralé) Počet hodin čekání mezi provedením zálohy clusteru int
initialCassandraAdminPassword Počáteční heslo pro klienty připojující se ke clusteru jako správce. Po vytvoření clusteru by se měly změnit. Vrátí hodnotu null pro get. Toto pole platí jenom v případě, že je pole authenticationMethod "Cassandra". řetězec

Omezení:
Citlivá hodnota. Předání jako zabezpečený parametr
prometheusEndpoint Název hostitele nebo IP adresa, kde je dostupný koncový bod Prometheus obsahující 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í'
"Odstraňuje se"
Chyba
'Succeeded'
Probíhá aktualizace
repairEnabled Měly by v tomto clusteru běžet automatické opravy? Pokud ho vynecháte, měl by zůstat pravdivý, pokud nespouštíte hybridní cluster, ve kterém už provádíte vlastní opravy. bool
restoreFromBackupId Pokud chcete vytvořit prázdný cluster, vyněž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

Certifikát

Název Description Hodnota
Pem Veřejný klíč formátovaný PEM. řetězec

SeedNode

Název Description Hodnota
ipAddress IP adresa tohoto počátečního uzlu. řetězec

CassandraError

Název Description 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

Definice prostředku šablony ARM

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

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í kód JSON.

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

Hodnoty vlastností

cassandraClusters

Název Description Hodnota
typ Typ prostředku Microsoft.DocumentDB/cassandraClusters
apiVersion Verze rozhraní API prostředku '2023-03-15'
name Název prostředku string (povinné)
location Umístění skupiny prostředků, do které prostředek patří. řetězec
tags Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč nejvýše 128 znaků a hodnotu nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: "Cassandra". Aktuální hodnoty defaultExperience zahrnují také "Table", "Graph", "DocumentDB" a "MongoDB". Slovník názvů značek a hodnot. Viz Značky v šablonách
identity Identita prostředku. ManagedCassandraManagedServiceIdentity
properties Vlastnosti spravovaného clusteru Cassandra ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Název Description Hodnota
typ Typ prostředku. 'Žádný'
'SystemAssigned'

ClusterResourceProperties

Název Description 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
'Žádný'
cassandraAuditLoggingEnabled Jestli je povolené protokolování auditu Cassandra bool
cassandraVersion Kterou verzi Cassandry by měl 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 zašifrovaná protokolem TLS bez ohledu na to, jestli je nastavená hodnota clientCertificates, ale pokud je nastavená hodnota clientCertificates, spravovaný cluster Cassandra odmítne všechna připojení bez klientského certifikátu TLS, která je možné ověřit z jednoho nebo více veřejných certifikátů v této vlastnosti. Certifikát[]
clusterNameOverride Pokud potřebujete nastavit vlastnost clusterName v souboru cassandra.yaml na něco kromě názvu prostředku clusteru, nastavte hodnotu, která se má použít pro tuto vlastnost. řetězec
Navrácen Jestli došlo k uvolnění clusteru a přidružených datových center. bool
delegatedManagementSubnetId ID prostředku podsítě, ke které by služba pro správu tohoto clusteru měla mít 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/{virtual network}/subnets/{subnet}. řetězec
externalGossipCertificates Seznam certifikátů TLS používaných k autorizaci klepů 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át[]
externalSeedNodes Seznam IP adres počátečních uzlů v nespravovaných datových centrech Ty se přidají do seznamů počátečních uzlů všech spravovaných uzlů. SeedNode[]
hoursBetweenBackups (Zastaralé) Počet hodin čekání mezi pořízením zálohy clusteru int
initialCassandraAdminPassword Počáteční heslo pro klienty, kteří se připojují ke clusteru jako správce. Po vytvoření clusteru by se měla změnit. Vrátí hodnotu null pro get. Toto pole platí jenom v případě, že pole authenticationMethod je Cassandra. řetězec

Omezení:
Citlivá hodnota. Předání jako zabezpečený parametr
prometheusEndpoint Název hostitele nebo IP adresa, kde je dostupný koncový bod Prometheus obsahující 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í'
"Odstraňuje se"
Neúspěšné
"Úspěch"
"Probíhá aktualizace"
repairEnabled Měly by v tomto clusteru běžet automatické opravy? Pokud tuto možnost vynecháte, platí to a měla by zůstat pravdivá, pokud nespravujete hybridní cluster, ve kterém už provádíte vlastní opravy. bool
restoreFromBackupId Pokud chcete vytvořit prázdný cluster, vyněž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

Certifikát

Název Description Hodnota
Pem Veřejný klíč formátovaný PEM. řetězec

SeedNode

Název Description Hodnota
ipAddress IP adresa tohoto počátečního uzlu. řetězec

CassandraError

Název Description 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

Definice prostředku Terraform (poskytovatel AzAPI)

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

  • 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@2023-03-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"
    }
  })
}

Hodnoty vlastností

cassandraClusters

Název Description Hodnota
typ Typ prostředku "Microsoft.DocumentDB/cassandraClusters@2023-03-15"
name Název prostředku string (povinné)
location Umístění skupiny prostředků, do které prostředek patří. řetězec
parent_id K nasazení do skupiny prostředků použijte ID této skupiny prostředků. string (povinné)
tags Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč, který nesmí být delší než 128 znaků a hodnota nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: Cassandra. Aktuální hodnoty defaultExperience také zahrnují "Table", "Graph", "DocumentDB" a "MongoDB". Slovník názvů a hodnot značek.
identity Identita prostředku. ManagedCassandraManagedServiceIdentity
properties Vlastnosti spravovaného clusteru Cassandra ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Název Description Hodnota
typ Typ prostředku. "SystemAssigned"

ClusterResourceProperties

Název Description 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"
"Žádné"
cassandraAuditLoggingEnabled Jestli je povolené protokolování auditu Cassandra bool
cassandraVersion Která verze Cassandry by měla 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 zašifrovaná protokolem TLS bez ohledu na to, jestli jsou nastaveny certifikáty clientCertificates, ale pokud je nastavená možnost clientCertificates, spravovaný cluster Cassandra odmítne všechna připojení bez certifikátu klienta TLS, který je možné ověřit z jednoho nebo více veřejných certifikátů v této vlastnosti. Certifikát[]
clusterNameOverride Pokud potřebujete nastavit vlastnost clusterName v souboru cassandra.yaml na něco kromě názvu prostředku clusteru, nastavte hodnotu, která se má použít pro tuto vlastnost. řetězec
Navrácen Určuje, jestli došlo k uvolnění clusteru a přidružených datových center. bool
delegatedManagementSubnetId ID prostředku podsítě, ke které má mít služba pro správu tohoto clusteru připojené síťové rozhraní. Podsíť musí být směrovatelná do všech 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/{subnet}. ř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ů poskytovaných v této vlastnosti. Certifikát[]
externalSeedNodes Seznam IP adres počátečních uzlů v nespravovaných datových centrech Ty se přidají do seznamu počátečních uzlů všech spravovaných uzlů. SeedNode[]
hoursBetweenBackups (Zastaralé) Počet hodin čekání mezi provedením zálohy clusteru int
initialCassandraAdminPassword Počáteční heslo pro klienty připojující se ke clusteru jako správce. Po vytvoření clusteru by se měly změnit. Vrátí hodnotu null pro get. Toto pole platí jenom v případě, že je pole authenticationMethod "Cassandra". řetězec

Omezení:
Citlivá hodnota. Předání jako zabezpečený parametr
prometheusEndpoint Název hostitele nebo IP adresa, kde je dostupný koncový bod Prometheus obsahující 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
"Succeeded" (Úspěch)
"Probíhá aktualizace"
repairEnabled Měly by v tomto clusteru běžet automatické opravy? Pokud ho vynecháte, měl by zůstat pravdivý, pokud nespouštíte hybridní cluster, ve kterém už provádíte vlastní opravy. bool
restoreFromBackupId Pokud chcete vytvořit prázdný cluster, vyněž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

Certifikát

Název Description Hodnota
Pem Veřejný klíč formátovaný PEM. řetězec

SeedNode

Název Description Hodnota
ipAddress IP adresa tohoto počátečního uzlu. řetězec

CassandraError

Název Description 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