Delen via


Microsoft.DocumentDB cassandraClusters 2023-03-15-preview

Bicep-resourcedefinitie

Het resourcetype cassandraClusters kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.DocumentDB/cassandraClusters-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2023-03-15-preview' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: '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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschapswaarden

CassandraError

Naam Beschrijving Waarde
additionalErrorInfo Aanvullende informatie over de fout. snaar
code De code van de fout die is opgetreden. snaar
Bericht Het bericht van de fout. snaar
doel De doelresource van de fout. snaar

Certificaat

Naam Beschrijving Waarde
Pem Openbare sleutel met PEM-indeling. snaar

ClusterResourceProperties

Naam Beschrijving Waarde
authenticationMethod Welke verificatiemethode Cassandra moet gebruiken om clients te verifiëren. 'Geen' schakelt verificatie uit, dus mag niet worden gebruikt, behalve in noodgevallen. Cassandra is de standaardverificatie op basis van wachtwoorden. De standaardwaarde is Cassandra. 'Cassandra'
'Ldap'
'Geen'
cassandraAuditLoggingEnabled Of Cassandra-auditlogboekregistratie is ingeschakeld Bool
cassandraVersion Welke versie van Cassandra moet dit cluster worden uitgevoerd (bijvoorbeeld 3.11). Wanneer het cluster is bijgewerkt, kan het enige tijd duren voordat het naar de nieuwe versie wordt gemigreerd. snaar
clientCertificates Lijst met TLS-certificaten die worden gebruikt voor het autoriseren van clients die verbinding maken met het cluster. Alle verbindingen zijn versleuteld met TLS, ongeacht of clientCertificates is ingesteld, maar als clientCertificates is ingesteld, worden alle verbindingen met een TLS-clientcertificaat dat kan worden gevalideerd vanuit een of meer van de openbare certificaten in deze eigenschap geweigerd door het beheerde Cassandra-cluster. Certificaat[]
clusterNameOverride Als u de eigenschap clusterName in cassandra.yaml wilt instellen op iets naast de resourcenaam van het cluster, stelt u de waarde in die voor deze eigenschap moet worden gebruikt. snaar
toewijzing ongedaan gemaakt Of de toewijzing van het cluster en de bijbehorende datacenters ongedaan is gemaakt. Bool
delegatedManagementSubnetId Resource-id van een subnet waaraan de beheerservice van dit cluster moet zijn gekoppeld. Het subnet moet routeerbaar zijn voor alle subnetten die worden gedelegeerd aan datacenters. De resource-id moet van het formulier /subscriptions/<subscription id>/resourceGroups/<resourcegroep>/providers/Microsoft.Network/virtualNetworks/<virtueel netwerk>/subnetten/<subnet>' snaar
externalGossipCertificates Lijst met TLS-certificaten die worden gebruikt voor het autoriseren van roddels vanuit niet-beheerde datacenters. De TLS-certificaten van alle knooppunten in onbeheerde datacenters moeten verifieerbaar zijn met behulp van een van de certificaten die in deze eigenschap zijn opgegeven. Certificaat[]
externalSeedNodes Lijst met IP-adressen van seed-knooppunten in niet-beheerde datacenters. Deze worden toegevoegd aan de seed-knooppuntlijsten van alle beheerde knooppunten. SeedNode[]
hoursBetweenBackups (Afgeschaft) Aantal uren dat moet worden gewacht tussen het maken van een back-up van het cluster. Int
initialCassandraAdminPassword Eerste wachtwoord voor clients die verbinding maken als beheerder met het cluster. Moet worden gewijzigd nadat het cluster is gemaakt. Retourneert null op GET. Dit veld is alleen van toepassing wanneer het veld authenticationMethod 'Cassandra' is. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
prometheusEndpoint Hostnaam of IP-adres waar het Prometheus-eindpunt met gegevens over de beheerde Cassandra-knooppunten kan worden bereikt. SeedNode-
provisionError Fout met betrekking tot het inrichten van resources. CassandraError-
provisioningState De status van de resource op het moment dat de bewerking werd aangeroepen. 'Geannuleerd'
'Maken'
'Verwijderen'
'Mislukt'
'Geslaagd'
'Bijwerken'
repairEnabled Moeten automatische reparaties worden uitgevoerd op dit cluster? Als u dit weglaat, is dit waar en moet dit waar blijven, tenzij u een hybride cluster uitvoert waarop u al uw eigen reparaties uitvoert. Bool
restoreFromBackupId Als u een leeg cluster wilt maken, laat u dit veld weg of stelt u dit in op null. Als u een back-up in een nieuw cluster wilt herstellen, stelt u dit veld in op de resource-id van de back-up. snaar

ManagedCassandraManagedServiceIdentity

Naam Beschrijving Waarde
type Het type resource. 'Geen'
'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

Naam Beschrijving Waarde
identiteit Identiteit voor de resource. ManagedCassandraManagedServiceIdentity-
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
Patroon = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (vereist)
Eigenschappen Eigenschappen van een beheerd Cassandra-cluster. ClusterResourceProperties-
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

SeedNode

Naam Beschrijving Waarde
ipAddress IP-adres van dit seed-knooppunt. snaar

Tags

Naam Beschrijving Waarde

Resourcedefinitie van ARM-sjabloon

Het resourcetype cassandraClusters kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.DocumentDB/cassandraClusters-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2023-03-15-preview",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschapswaarden

CassandraError

Naam Beschrijving Waarde
additionalErrorInfo Aanvullende informatie over de fout. snaar
code De code van de fout die is opgetreden. snaar
Bericht Het bericht van de fout. snaar
doel De doelresource van de fout. snaar

Certificaat

Naam Beschrijving Waarde
Pem Openbare sleutel met PEM-indeling. snaar

ClusterResourceProperties

Naam Beschrijving Waarde
authenticationMethod Welke verificatiemethode Cassandra moet gebruiken om clients te verifiëren. 'Geen' schakelt verificatie uit, dus mag niet worden gebruikt, behalve in noodgevallen. Cassandra is de standaardverificatie op basis van wachtwoorden. De standaardwaarde is Cassandra. 'Cassandra'
'Ldap'
'Geen'
cassandraAuditLoggingEnabled Of Cassandra-auditlogboekregistratie is ingeschakeld Bool
cassandraVersion Welke versie van Cassandra moet dit cluster worden uitgevoerd (bijvoorbeeld 3.11). Wanneer het cluster is bijgewerkt, kan het enige tijd duren voordat het naar de nieuwe versie wordt gemigreerd. snaar
clientCertificates Lijst met TLS-certificaten die worden gebruikt voor het autoriseren van clients die verbinding maken met het cluster. Alle verbindingen zijn versleuteld met TLS, ongeacht of clientCertificates is ingesteld, maar als clientCertificates is ingesteld, worden alle verbindingen met een TLS-clientcertificaat dat kan worden gevalideerd vanuit een of meer van de openbare certificaten in deze eigenschap geweigerd door het beheerde Cassandra-cluster. Certificaat[]
clusterNameOverride Als u de eigenschap clusterName in cassandra.yaml wilt instellen op iets naast de resourcenaam van het cluster, stelt u de waarde in die voor deze eigenschap moet worden gebruikt. snaar
toewijzing ongedaan gemaakt Of de toewijzing van het cluster en de bijbehorende datacenters ongedaan is gemaakt. Bool
delegatedManagementSubnetId Resource-id van een subnet waaraan de beheerservice van dit cluster moet zijn gekoppeld. Het subnet moet routeerbaar zijn voor alle subnetten die worden gedelegeerd aan datacenters. De resource-id moet van het formulier /subscriptions/<subscription id>/resourceGroups/<resourcegroep>/providers/Microsoft.Network/virtualNetworks/<virtueel netwerk>/subnetten/<subnet>' snaar
externalGossipCertificates Lijst met TLS-certificaten die worden gebruikt voor het autoriseren van roddels vanuit niet-beheerde datacenters. De TLS-certificaten van alle knooppunten in onbeheerde datacenters moeten verifieerbaar zijn met behulp van een van de certificaten die in deze eigenschap zijn opgegeven. Certificaat[]
externalSeedNodes Lijst met IP-adressen van seed-knooppunten in niet-beheerde datacenters. Deze worden toegevoegd aan de seed-knooppuntlijsten van alle beheerde knooppunten. SeedNode[]
hoursBetweenBackups (Afgeschaft) Aantal uren dat moet worden gewacht tussen het maken van een back-up van het cluster. Int
initialCassandraAdminPassword Eerste wachtwoord voor clients die verbinding maken als beheerder met het cluster. Moet worden gewijzigd nadat het cluster is gemaakt. Retourneert null op GET. Dit veld is alleen van toepassing wanneer het veld authenticationMethod 'Cassandra' is. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
prometheusEndpoint Hostnaam of IP-adres waar het Prometheus-eindpunt met gegevens over de beheerde Cassandra-knooppunten kan worden bereikt. SeedNode-
provisionError Fout met betrekking tot het inrichten van resources. CassandraError-
provisioningState De status van de resource op het moment dat de bewerking werd aangeroepen. 'Geannuleerd'
'Maken'
'Verwijderen'
'Mislukt'
'Geslaagd'
'Bijwerken'
repairEnabled Moeten automatische reparaties worden uitgevoerd op dit cluster? Als u dit weglaat, is dit waar en moet dit waar blijven, tenzij u een hybride cluster uitvoert waarop u al uw eigen reparaties uitvoert. Bool
restoreFromBackupId Als u een leeg cluster wilt maken, laat u dit veld weg of stelt u dit in op null. Als u een back-up in een nieuw cluster wilt herstellen, stelt u dit veld in op de resource-id van de back-up. snaar

ManagedCassandraManagedServiceIdentity

Naam Beschrijving Waarde
type Het type resource. 'Geen'
'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

Naam Beschrijving Waarde
apiVersion De API-versie '2023-03-15-preview'
identiteit Identiteit voor de resource. ManagedCassandraManagedServiceIdentity-
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
Patroon = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (vereist)
Eigenschappen Eigenschappen van een beheerd Cassandra-cluster. ClusterResourceProperties-
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type Het resourcetype 'Microsoft.DocumentDB/cassandraClusters'

SeedNode

Naam Beschrijving Waarde
ipAddress IP-adres van dit seed-knooppunt. snaar

Tags

Naam Beschrijving Waarde

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype cassandraClusters kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.DocumentDB/cassandraClusters-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2023-03-15-preview"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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"
    }
  })
}

Eigenschapswaarden

CassandraError

Naam Beschrijving Waarde
additionalErrorInfo Aanvullende informatie over de fout. snaar
code De code van de fout die is opgetreden. snaar
Bericht Het bericht van de fout. snaar
doel De doelresource van de fout. snaar

Certificaat

Naam Beschrijving Waarde
Pem Openbare sleutel met PEM-indeling. snaar

ClusterResourceProperties

Naam Beschrijving Waarde
authenticationMethod Welke verificatiemethode Cassandra moet gebruiken om clients te verifiëren. 'Geen' schakelt verificatie uit, dus mag niet worden gebruikt, behalve in noodgevallen. Cassandra is de standaardverificatie op basis van wachtwoorden. De standaardwaarde is Cassandra. 'Cassandra'
'Ldap'
'Geen'
cassandraAuditLoggingEnabled Of Cassandra-auditlogboekregistratie is ingeschakeld Bool
cassandraVersion Welke versie van Cassandra moet dit cluster worden uitgevoerd (bijvoorbeeld 3.11). Wanneer het cluster is bijgewerkt, kan het enige tijd duren voordat het naar de nieuwe versie wordt gemigreerd. snaar
clientCertificates Lijst met TLS-certificaten die worden gebruikt voor het autoriseren van clients die verbinding maken met het cluster. Alle verbindingen zijn versleuteld met TLS, ongeacht of clientCertificates is ingesteld, maar als clientCertificates is ingesteld, worden alle verbindingen met een TLS-clientcertificaat dat kan worden gevalideerd vanuit een of meer van de openbare certificaten in deze eigenschap geweigerd door het beheerde Cassandra-cluster. Certificaat[]
clusterNameOverride Als u de eigenschap clusterName in cassandra.yaml wilt instellen op iets naast de resourcenaam van het cluster, stelt u de waarde in die voor deze eigenschap moet worden gebruikt. snaar
toewijzing ongedaan gemaakt Of de toewijzing van het cluster en de bijbehorende datacenters ongedaan is gemaakt. Bool
delegatedManagementSubnetId Resource-id van een subnet waaraan de beheerservice van dit cluster moet zijn gekoppeld. Het subnet moet routeerbaar zijn voor alle subnetten die worden gedelegeerd aan datacenters. De resource-id moet van het formulier /subscriptions/<subscription id>/resourceGroups/<resourcegroep>/providers/Microsoft.Network/virtualNetworks/<virtueel netwerk>/subnetten/<subnet>' snaar
externalGossipCertificates Lijst met TLS-certificaten die worden gebruikt voor het autoriseren van roddels vanuit niet-beheerde datacenters. De TLS-certificaten van alle knooppunten in onbeheerde datacenters moeten verifieerbaar zijn met behulp van een van de certificaten die in deze eigenschap zijn opgegeven. Certificaat[]
externalSeedNodes Lijst met IP-adressen van seed-knooppunten in niet-beheerde datacenters. Deze worden toegevoegd aan de seed-knooppuntlijsten van alle beheerde knooppunten. SeedNode[]
hoursBetweenBackups (Afgeschaft) Aantal uren dat moet worden gewacht tussen het maken van een back-up van het cluster. Int
initialCassandraAdminPassword Eerste wachtwoord voor clients die verbinding maken als beheerder met het cluster. Moet worden gewijzigd nadat het cluster is gemaakt. Retourneert null op GET. Dit veld is alleen van toepassing wanneer het veld authenticationMethod 'Cassandra' is. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
prometheusEndpoint Hostnaam of IP-adres waar het Prometheus-eindpunt met gegevens over de beheerde Cassandra-knooppunten kan worden bereikt. SeedNode-
provisionError Fout met betrekking tot het inrichten van resources. CassandraError-
provisioningState De status van de resource op het moment dat de bewerking werd aangeroepen. 'Geannuleerd'
'Maken'
'Verwijderen'
'Mislukt'
'Geslaagd'
'Bijwerken'
repairEnabled Moeten automatische reparaties worden uitgevoerd op dit cluster? Als u dit weglaat, is dit waar en moet dit waar blijven, tenzij u een hybride cluster uitvoert waarop u al uw eigen reparaties uitvoert. Bool
restoreFromBackupId Als u een leeg cluster wilt maken, laat u dit veld weg of stelt u dit in op null. Als u een back-up in een nieuw cluster wilt herstellen, stelt u dit veld in op de resource-id van de back-up. snaar

ManagedCassandraManagedServiceIdentity

Naam Beschrijving Waarde
type Het type resource. 'Geen'
'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

Naam Beschrijving Waarde
identiteit Identiteit voor de resource. ManagedCassandraManagedServiceIdentity-
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
Patroon = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (vereist)
Eigenschappen Eigenschappen van een beheerd Cassandra-cluster. ClusterResourceProperties-
Tags Resourcetags Woordenlijst met tagnamen en -waarden.
type Het resourcetype "Microsoft.DocumentDB/cassandraClusters@2023-03-15-preview"

SeedNode

Naam Beschrijving Waarde
ipAddress IP-adres van dit seed-knooppunt. snaar

Tags

Naam Beschrijving Waarde