Delen via


Microsoft.DocumentDB cassandraClusters 2021-07-01-preview

Bicep-resourcedefinitie

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

Zie wijzigingenlogboek voor 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@2021-07-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    authenticationMethod: 'string'
    cassandraVersion: 'string'
    clientCertificates: [
      {
        pem: 'string'
      }
    ]
    clusterNameOverride: 'string'
    delegatedManagementSubnetId: 'string'
    externalGossipCertificates: [
      {
        pem: 'string'
      }
    ]
    externalSeedNodes: [
      {
        ipAddress: 'string'
      }
    ]
    hoursBetweenBackups: int
    initialCassandraAdminPassword: 'string'
    prometheusEndpoint: {
      ipAddress: 'string'
    }
    provisioningState: 'string'
    repairEnabled: bool
    restoreFromBackupId: 'string'
  }
}

Eigenschapswaarden

cassandraClusters

Naam Description Waarde
naam De resourcenaam tekenreeks (vereist)
location De locatie van de resourcegroep waartoe de resource behoort. tekenreeks
tags Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en de waarde niet groter is dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
identity Identiteit voor de resource. ManagedServiceIdentity
properties Eigenschappen van een beheerd Cassandra-cluster. ClusterResourceProperties

ManagedServiceIdentity

Naam Description Waarde
type Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. 'Geen'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedId-entiteiten

ManagedServiceIdentityUserAssignedId-entiteiten

Naam Description Waarde
{aangepaste eigenschap} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn Alleen-lezen.

ClusterResourceProperties

Naam Description 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 een wachtwoord. De standaardwaarde is Cassandra. 'Cassandra'
'Geen'
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 is gemigreerd. tekenreeks
clientCertificaten Lijst met TLS-certificaten die worden gebruikt voor het autoriseren van clients die verbinding maken met het cluster. Alle verbindingen worden met TLS versleuteld, ongeacht of clientCertificaten is ingesteld of niet, maar als clientCertificaten is ingesteld, weigert het beheerde Cassandra-cluster alle verbindingen die geen TLS-clientcertificaat bevatten dat kan worden gevalideerd vanuit een of meer van de openbare certificaten in deze eigenschap. Certificaat[]
clusterNameOverride Als u de eigenschap clusterName in cassandra.yaml wilt instellen op iets anders dan de resourcenaam van het cluster, stelt u de waarde in die voor deze eigenschap moet worden gebruikt. tekenreeks
delegatedManagementSubnetId Resource-id van een subnet waaraan de beheerservice van dit cluster moet zijn gekoppeld. Het subnet moet routeerbaar zijn naar alle subnetten die worden gedelegeerd aan datacenters. De resource-id moet de volgende notatie hebben: /subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' tekenreeks
externalGossipCertificates Lijst met TLS-certificaten die worden gebruikt voor het autoriseren van roddels van niet-beheerde datacenters. De TLS-certificaten van alle knooppunten in onbeheerde datacenters moeten verifieerbaar zijn met behulp van een van de certificaten in deze eigenschap. 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 Het aantal uren dat moet worden gewacht tussen het maken van een back-up van het cluster. Als u back-ups wilt uitschakelen, stelt u deze eigenschap in op 0. int
initialCassandraAdminPassword Eerste wachtwoord voor clients die als beheerder verbinding maken met het cluster. Moet worden gewijzigd nadat het cluster is gemaakt. Retourneert null op GET. Dit veld is alleen van toepassing als het veld authenticationMethod 'Cassandra' is. tekenreeks

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
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 waarin u al uw eigen reparaties uitvoert. booleaans
restoreFromBackupId Als u een leeg cluster wilt maken, laat u dit veld weg of stelt u het 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. tekenreeks

Certificaat

Naam Description Waarde
Pem Openbare sleutel met PEM-indeling. tekenreeks

SeedNode

Naam Description Waarde
ipAddress IP-adres van dit seed-knooppunt. tekenreeks

Resourcedefinitie van ARM-sjabloon

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

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2021-07-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "authenticationMethod": "string",
    "cassandraVersion": "string",
    "clientCertificates": [
      {
        "pem": "string"
      }
    ],
    "clusterNameOverride": "string",
    "delegatedManagementSubnetId": "string",
    "externalGossipCertificates": [
      {
        "pem": "string"
      }
    ],
    "externalSeedNodes": [
      {
        "ipAddress": "string"
      }
    ],
    "hoursBetweenBackups": "int",
    "initialCassandraAdminPassword": "string",
    "prometheusEndpoint": {
      "ipAddress": "string"
    },
    "provisioningState": "string",
    "repairEnabled": "bool",
    "restoreFromBackupId": "string"
  }
}

Eigenschapswaarden

cassandraClusters

Naam Description Waarde
type Het resourcetype 'Microsoft.DocumentDB/cassandraClusters'
apiVersion De resource-API-versie '2021-07-01-preview'
naam De resourcenaam tekenreeks (vereist)
location De locatie van de resourcegroep waartoe de resource behoort. tekenreeks
tags Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (in resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en een waarde van niet meer dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige waarden voor 'defaultExperience' omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
identity Identiteit voor de resource. ManagedServiceIdentity
properties Eigenschappen van een beheerd Cassandra-cluster. ClusterResourceProperties

ManagedServiceIdentity

Naam Description Waarde
type Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. 'Geen'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedId-entiteiten

ManagedServiceIdentityUserAssignedId-entiteiten

Naam Description Waarde
{aangepaste eigenschap} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn Alleen-lezen.

ClusterResourceProperties

Naam Description 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 een wachtwoord. De standaardwaarde is Cassandra. 'Cassandra'
'Geen'
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 is gemigreerd. tekenreeks
clientCertificaten Lijst met TLS-certificaten die worden gebruikt om clients te autoriseren die verbinding maken met het cluster. Alle verbindingen zijn TLS-versleuteld, ongeacht of clientCertificaten is ingesteld of niet, maar als clientCertificates is ingesteld, weigert het beheerde Cassandra-cluster alle verbindingen die niet voorzien zijn van een TLS-clientcertificaat dat kan worden gevalideerd vanuit een of meer van de openbare certificaten in deze eigenschap. 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. tekenreeks
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 de volgende notatie hebben: /subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' tekenreeks
externalGossipCertificates Lijst met TLS-certificaten die worden gebruikt om roddels van onbeheerde datacenters te autoriseren. De TLS-certificaten van alle knooppunten in onbeheerde datacenters moeten kunnen worden verifieerbaar met behulp van een van de certificaten die in deze eigenschap zijn opgegeven. Certificaat[]
externalSeedNodes Lijst met IP-adressen van seed-knooppunten in onbeheerde datacenters. Deze worden toegevoegd aan de seed-knooppuntlijsten van alle beheerde knooppunten. SeedNode[]
hoursBetweenBackups Het aantal uren dat moet worden gewacht tussen het maken van een back-up van het cluster. Als u back-ups wilt uitschakelen, stelt u deze eigenschap in op 0. int
initialCassandraAdminPassword Eerste wachtwoord voor clients die als beheerder verbinding maken met het cluster. Moet worden gewijzigd nadat het cluster is gemaakt. Retourneert null op GET. Dit veld is alleen van toepassing als het veld authenticationMethod 'Cassandra' is. tekenreeks

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
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 waarin u al uw eigen reparaties uitvoert. booleaans
restoreFromBackupId Als u een leeg cluster wilt maken, laat u dit veld weg of stelt u het in op null. Als u een back-up wilt herstellen naar een nieuw cluster, stelt u dit veld in op de resource-id van de back-up. tekenreeks

Certificaat

Naam Description Waarde
Pem Openbare sleutel met PEM-indeling. tekenreeks

SeedNode

Naam Description Waarde
ipAddress IP-adres van dit seed-knooppunt. tekenreeks

Terraform-resourcedefinitie (AzAPI-provider)

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

  • Resourcegroepen

Zie wijzigingenlogboek voor 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@2021-07-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      authenticationMethod = "string"
      cassandraVersion = "string"
      clientCertificates = [
        {
          pem = "string"
        }
      ]
      clusterNameOverride = "string"
      delegatedManagementSubnetId = "string"
      externalGossipCertificates = [
        {
          pem = "string"
        }
      ]
      externalSeedNodes = [
        {
          ipAddress = "string"
        }
      ]
      hoursBetweenBackups = int
      initialCassandraAdminPassword = "string"
      prometheusEndpoint = {
        ipAddress = "string"
      }
      provisioningState = "string"
      repairEnabled = bool
      restoreFromBackupId = "string"
    }
  })
}

Eigenschapswaarden

cassandraClusters

Naam Description Waarde
type Het resourcetype "Microsoft.DocumentDB/cassandraClusters@2021-07-01-preview"
naam De resourcenaam tekenreeks (vereist)
location De locatie van de resourcegroep waartoe de resource behoort. tekenreeks
parent_id Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep. tekenreeks (vereist)
tags Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en de waarde niet groter is dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'. Woordenlijst met tagnamen en -waarden.
identity Identiteit voor de resource. ManagedServiceIdentity
properties Eigenschappen van een beheerd Cassandra-cluster. ClusterResourceProperties

ManagedServiceIdentity

Naam Description Waarde
type Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Matrix met gebruikersidentiteits-id's.

ManagedServiceIdentityUserAssignedId-entiteiten

Naam Description Waarde
{aangepaste eigenschap} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn Alleen-lezen.

ClusterResourceProperties

Naam Description 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 een wachtwoord. De standaardwaarde is Cassandra. "Cassandra"
"Geen"
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 is gemigreerd. tekenreeks
clientCertificaten Lijst met TLS-certificaten die worden gebruikt om clients te autoriseren die verbinding maken met het cluster. Alle verbindingen zijn TLS-versleuteld, ongeacht of clientCertificaten is ingesteld of niet, maar als clientCertificates is ingesteld, weigert het beheerde Cassandra-cluster alle verbindingen die niet voorzien zijn van een TLS-clientcertificaat dat kan worden gevalideerd vanuit een of meer van de openbare certificaten in deze eigenschap. 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. tekenreeks
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 de volgende notatie hebben: /subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' tekenreeks
externalGossipCertificates Lijst met TLS-certificaten die worden gebruikt voor het autoriseren van roddels van niet-beheerde datacenters. De TLS-certificaten van alle knooppunten in onbeheerde datacenters moeten verifieerbaar zijn met behulp van een van de certificaten in deze eigenschap. 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 Het aantal uren dat moet worden gewacht tussen het maken van een back-up van het cluster. Als u back-ups wilt uitschakelen, stelt u deze eigenschap in op 0. int
initialCassandraAdminPassword Eerste wachtwoord voor clients die als beheerder verbinding maken met het cluster. Moet worden gewijzigd nadat het cluster is gemaakt. Retourneert null op GET. Dit veld is alleen van toepassing als het veld authenticationMethod 'Cassandra' is. tekenreeks

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
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 waarin u al uw eigen reparaties uitvoert. booleaans
restoreFromBackupId Als u een leeg cluster wilt maken, laat u dit veld weg of stelt u het 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. tekenreeks

Certificaat

Naam Description Waarde
Pem Openbare sleutel met PEM-indeling. tekenreeks

SeedNode

Naam Description Waarde
ipAddress IP-adres van dit seed-knooppunt. tekenreeks