Condividi tramite

Microsoft.DocumentDB cassandraClusters 2023-09-15-preview

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa cassandraClusters può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/cassandraClusters, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
  }
  properties: {
    authenticationMethod: 'string'
    backupSchedules: [
      {
        cronExpression: 'string'
        retentionInHours: int
        scheduleName: 'string'
      }
    ]
    cassandraAuditLoggingEnabled: bool
    cassandraVersion: 'string'
    clientCertificates: [
      {
        pem: 'string'
      }
    ]
    clusterNameOverride: 'string'
    clusterType: 'string'
    deallocated: bool
    delegatedManagementSubnetId: 'string'
    extensions: [
      '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'
  }
}

Valori delle proprietà

cassandraClusters

Nome Descrizione valore
name Nome della risorsa stringa (obbligatoria)
posizione Posizione del gruppo di risorse a cui appartiene la risorsa. string
tags I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori "defaultExperience" correnti includono anche "Table", "Graph", "DocumentDB" e "MongoDB". Dizionario dei nomi e dei valori dei tag. Vedere Tag nei modelli
identity Identità per la risorsa. ManagedCassandraManagedServiceIdentity
properties Proprietà di un cluster Cassandra gestito. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nome Descrizione Valore
tipo Tipo di risorsa. 'Nessuno'
'SystemAssigned'

ClusterResourceProperties

Nome Descrizione Valore
authenticationMethod Quale metodo di autenticazione Cassandra deve usare per autenticare i client. "Nessuno" disattiva l'autenticazione, quindi non deve essere usata ad eccezione delle emergenze. 'Cassandra' è l'autenticazione basata su password predefinita. Il valore predefinito è "Cassandra". 'Cassandra'
'Ldap'
'Nessuno'
backupSchedules Elenco delle pianificazioni di backup che definiscono quando si desidera eseguire il backup dei dati. BackupSchedule[]
cassandraAuditLoggingEnabled Se la registrazione del controllo Cassandra è abilitata bool
cassandraVersion Quale versione di Cassandra dovrebbe essere convergente per l'esecuzione del cluster (ad esempio, 3.11). Quando viene aggiornato, il cluster potrebbe richiedere tempo per eseguire la migrazione alla nuova versione. string
Clientcertificates Elenco dei certificati TLS usati per autorizzare i client che si connettono al cluster. Tutte le connessioni sono crittografate se clientCertificates è impostato o meno, ma se il clientCertificates è impostato, il cluster Cassandra gestito rifiuterà tutte le connessioni che non contiene un certificato client TLS che può essere convalidato da uno o più certificati pubblici in questa proprietà. Certificato[]
clusterNameOverride Se è necessario impostare la proprietà clusterName in cassandra.yaml su un elemento oltre al nome della risorsa del cluster, impostare il valore da usare in questa proprietà. string
clusterType Tipo del cluster. Se impostato su Produzione, alcune operazioni potrebbero non essere consentite nel cluster. 'NonProduction'
'Produzione'
Deallocato Indica se il cluster e i data center associati sono stati deallocati. bool
delegatedManagementSubnetId ID risorsa di una subnet a cui deve essere collegata l'interfaccia di rete del servizio di gestione del cluster. La subnet deve essere instradabile a tutte le subnet che verranno delegate ai data center. L'ID risorsa deve essere nel formato '/subscriptions/{id sottoscrizione}/resourceGroups/{gruppo di risorse}/providers/Microsoft.Network/virtualNetworks/{rete virtuale}/subnets/{subnet}' string
Estensioni Estensioni da aggiungere o aggiornare nel cluster. string[]
externalGossipCertificates Elenco di certificati TLS usati per autorizzare gossip da data center non gestiti. I certificati TLS di tutti i nodi nei data center non gestiti devono essere verificabili usando uno dei certificati forniti in questa proprietà. Certificato[]
externalSeedNodes Elenco di indirizzi IP dei nodi di inizializzazione nei data center non gestiti. Questi verranno aggiunti agli elenchi di nodi di inizializzazione di tutti i nodi gestiti. SeedNode[]
hoursBetweenBackups (Deprecato) Numero di ore di attesa tra l'esecuzione di un backup del cluster. INT
initialCassandraAdminPassword Password iniziale per i client che si connettono come amministratore al cluster. Deve essere modificato dopo la creazione del cluster. Restituisce Null in GET. Questo campo si applica solo quando il campo authenticationMethod è "Cassandra". string

Vincoli:
Valore sensibile. Passare come parametro sicuro.
prometheusEndpoint Nome host o indirizzo IP in cui è possibile raggiungere l'endpoint Prometheus contenente dati sui nodi Cassandra gestiti. SeedNode
provisionError Errore correlato al provisioning delle risorse. CassandraError
provisioningState Stato della risorsa al momento della chiamata dell'operazione. 'Annullata'
'Creating'
'Eliminazione'
'Failed'
'Succeeded'
'Aggiornamento'
repairEnabled Le riparazioni automatiche devono essere eseguite in questo cluster? Se omesso, si tratta di true e deve rimanere true a meno che non si stia eseguendo un cluster ibrido in cui si stanno già eseguendo riparazioni personalizzate. bool
restoreFromBackupId Per creare un cluster vuoto, omettere questo campo o impostarlo su Null. Per ripristinare un backup in un nuovo cluster, impostare questo campo sull'ID risorsa del backup. string

BackupSchedule

Nome Descrizione Valore
cronExpression Espressione cron che definisce quando si vuole eseguire il backup dei dati. string
retentionInHours Periodo di conservazione (ore) dei backup. Se si desidera conservare i dati per sempre, impostare la conservazione su 0. INT
scheduleName Identificatore univoco della pianificazione del backup. string

Certificato

Nome Descrizione Valore
Pem Chiave pubblica in formato PEM. string

SeedNode

Nome Descrizione Valore
IpAddress Indirizzo IP di questo nodo di inizializzazione. string

CassandraError

Nome Descrizione Valore
additionalErrorInfo Informazioni aggiuntive sull'errore. string
codice Codice di errore che si è verificato. string
message Messaggio dell'errore. string
target Risorsa di destinazione dell'errore. string

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa cassandraClusters può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/cassandraClusters, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2023-09-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string"
  },
  "properties": {
    "authenticationMethod": "string",
    "backupSchedules": [
      {
        "cronExpression": "string",
        "retentionInHours": "int",
        "scheduleName": "string"
      }
    ],
    "cassandraAuditLoggingEnabled": "bool",
    "cassandraVersion": "string",
    "clientCertificates": [
      {
        "pem": "string"
      }
    ],
    "clusterNameOverride": "string",
    "clusterType": "string",
    "deallocated": "bool",
    "delegatedManagementSubnetId": "string",
    "extensions": [ "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"
  }
}

Valori delle proprietà

cassandraClusters

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.DocumentDB/cassandraClusters'
apiVersion Versione dell'API risorsa '2023-09-15-preview'
name Nome della risorsa stringa (obbligatoria)
posizione Posizione del gruppo di risorse a cui appartiene la risorsa. string
tags I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori "defaultExperience" correnti includono anche "Table", "Graph", "DocumentDB" e "MongoDB". Dizionario dei nomi e dei valori dei tag. Vedere Tag nei modelli
identity Identità per la risorsa. ManagedCassandraManagedServiceIdentity
properties Proprietà di un cluster Cassandra gestito. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nome Descrizione Valore
tipo Tipo di risorsa. 'Nessuno'
'SystemAssigned'

ClusterResourceProperties

Nome Descrizione Valore
authenticationMethod Quale metodo di autenticazione Cassandra deve usare per autenticare i client. "Nessuno" disattiva l'autenticazione, quindi non deve essere usata ad eccezione delle emergenze. 'Cassandra' è l'autenticazione basata su password predefinita. Il valore predefinito è "Cassandra". 'Cassandra'
'Ldap'
'Nessuno'
backupSchedules Elenco delle pianificazioni di backup che definiscono quando si desidera eseguire il backup dei dati. BackupSchedule[]
cassandraAuditLoggingEnabled Se la registrazione del controllo Cassandra è abilitata bool
cassandraVersion Quale versione di Cassandra dovrebbe essere convergente per l'esecuzione del cluster (ad esempio, 3.11). Quando viene aggiornato, il cluster potrebbe richiedere tempo per eseguire la migrazione alla nuova versione. string
Clientcertificates Elenco dei certificati TLS usati per autorizzare i client che si connettono al cluster. Tutte le connessioni sono crittografate se clientCertificates è impostato o meno, ma se il clientCertificates è impostato, il cluster Cassandra gestito rifiuterà tutte le connessioni che non contiene un certificato client TLS che può essere convalidato da uno o più certificati pubblici in questa proprietà. Certificato[]
clusterNameOverride Se è necessario impostare la proprietà clusterName in cassandra.yaml su un elemento oltre al nome della risorsa del cluster, impostare il valore da usare in questa proprietà. string
clusterType Tipo del cluster. Se impostato su Produzione, alcune operazioni potrebbero non essere consentite nel cluster. 'NonProduction'
'Produzione'
Deallocato Se il cluster e i data center associati sono stati deallocati. bool
delegatedManagementSubnetId ID risorsa di una subnet a cui deve essere collegato il servizio di gestione del cluster. La subnet deve essere instradabile a tutte le subnet che verranno delegate ai data center. L'ID risorsa deve essere del modulo '/subscriptions/{id sottoscrizione}/resourceGroups/{gruppo di risorse}/provider/Microsoft.Network/virtualNetworks/{rete virtuale}/subnet/{subnet}' string
Estensioni Estensioni da aggiungere o aggiornare nel cluster. string[]
externalGossipCertificates Elenco dei certificati TLS usati per autorizzare gossip da data center non gestiti. I certificati TLS di tutti i nodi nei data center non gestiti devono essere verificabili usando uno dei certificati forniti in questa proprietà. Certificato[]
externalSeedNodes Elenco degli indirizzi IP dei nodi di inizializzazione nei data center non gestiti. Verranno aggiunti agli elenchi di nodi di inizializzazione di tutti i nodi gestiti. SeedNode[]
hoursBetweenBackups (Deprecato) Numero di ore di attesa tra l'esecuzione di un backup del cluster. INT
initialCassandraAdminPassword Password iniziale per i client che si connettono come amministratore al cluster. Deve essere modificato dopo la creazione del cluster. Restituisce Null in GET. Questo campo si applica solo quando il campo authenticationMethod è "Cassandra". string

Vincoli:
Valore sensibile. Passare come parametro sicuro.
prometheusEndpoint Nome host o indirizzo IP in cui è possibile raggiungere l'endpoint Prometheus contenente dati sui nodi Cassandra gestiti. SeedNode
provisionError Errore correlato al provisioning delle risorse. CassandraError
provisioningState Stato della risorsa al momento della chiamata dell'operazione. 'Annullata'
'Creating'
'Eliminazione'
'Failed'
'Succeeded'
'Aggiornamento'
repairEnabled Le riparazioni automatiche devono essere eseguite in questo cluster? Se omesso, si tratta di true e deve rimanere true a meno che non si stia eseguendo un cluster ibrido in cui si stanno già eseguendo riparazioni personalizzate. bool
restoreFromBackupId Per creare un cluster vuoto, omettere questo campo o impostarlo su Null. Per ripristinare un backup in un nuovo cluster, impostare questo campo sull'ID risorsa del backup. string

BackupSchedule

Nome Descrizione Valore
cronExpression Espressione cron che definisce quando si vuole eseguire il backup dei dati. string
retentionInHours Periodo di conservazione (ore) dei backup. Se si desidera conservare i dati per sempre, impostare la conservazione su 0. INT
scheduleName Identificatore univoco della pianificazione del backup. string

Certificato

Nome Descrizione Valore
Pem Chiave pubblica in formato PEM. string

SeedNode

Nome Descrizione Valore
IpAddress Indirizzo IP di questo nodo di inizializzazione. string

CassandraError

Nome Descrizione Valore
additionalErrorInfo Informazioni aggiuntive sull'errore. string
codice Codice di errore che si è verificato. string
message Messaggio dell'errore. string
target Risorsa di destinazione dell'errore. string

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa cassandraClusters può essere distribuito con operazioni destinate a:

  • Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/cassandraClusters, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      authenticationMethod = "string"
      backupSchedules = [
        {
          cronExpression = "string"
          retentionInHours = int
          scheduleName = "string"
        }
      ]
      cassandraAuditLoggingEnabled = bool
      cassandraVersion = "string"
      clientCertificates = [
        {
          pem = "string"
        }
      ]
      clusterNameOverride = "string"
      clusterType = "string"
      deallocated = bool
      delegatedManagementSubnetId = "string"
      extensions = [
        "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"
    }
  })
}

Valori delle proprietà

cassandraClusters

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview"
name Nome della risorsa stringa (obbligatorio)
posizione Posizione del gruppo di risorse a cui appartiene la risorsa. string
parent_id Per eseguire la distribuzione in un gruppo di risorse, usare l'ID del gruppo di risorse. stringa (obbligatorio)
tags I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori "defaultExperience" correnti includono anche "Table", "Graph", "DocumentDB" e "MongoDB". Dizionario dei nomi e dei valori dei tag.
identity Identità per la risorsa. ManagedCassandraManagedServiceIdentity
properties Proprietà di un cluster Cassandra gestito. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nome Descrizione Valore
tipo Tipo di risorsa. "SystemAssigned"

ClusterResourceProperties

Nome Descrizione Valore
authenticationMethod Quale metodo di autenticazione Cassandra deve usare per autenticare i client. "Nessuno" disattiva l'autenticazione, quindi non deve essere usata ad eccezione delle emergenze. 'Cassandra' è l'autenticazione basata su password predefinita. Il valore predefinito è "Cassandra". "Cassandra"
"Ldap"
"None"
backupSchedules Elenco delle pianificazioni di backup che definiscono quando si desidera eseguire il backup dei dati. BackupSchedule[]
cassandraAuditLoggingEnabled Se la registrazione del controllo Cassandra è abilitata bool
cassandraVersion Quale versione di Cassandra dovrebbe essere convergente per l'esecuzione del cluster (ad esempio, 3.11). Quando viene aggiornato, il cluster potrebbe richiedere tempo per eseguire la migrazione alla nuova versione. string
Clientcertificates Elenco dei certificati TLS usati per autorizzare i client che si connettono al cluster. Tutte le connessioni sono crittografate se clientCertificates è impostato o meno, ma se il clientCertificates è impostato, il cluster Cassandra gestito rifiuterà tutte le connessioni che non contiene un certificato client TLS che può essere convalidato da uno o più certificati pubblici in questa proprietà. Certificato[]
clusterNameOverride Se è necessario impostare la proprietà clusterName in cassandra.yaml su un elemento oltre al nome della risorsa del cluster, impostare il valore da usare in questa proprietà. string
clusterType Tipo del cluster. Se impostato su Produzione, alcune operazioni potrebbero non essere consentite nel cluster. "NonProduction"
"Produzione"
Deallocato Se il cluster e i data center associati sono stati deallocati. bool
delegatedManagementSubnetId ID risorsa di una subnet a cui deve essere collegato il servizio di gestione del cluster. La subnet deve essere instradabile a tutte le subnet che verranno delegate ai data center. L'ID risorsa deve essere del modulo '/subscriptions/{id sottoscrizione}/resourceGroups/{gruppo di risorse}/provider/Microsoft.Network/virtualNetworks/{rete virtuale}/subnet/{subnet}' string
Estensioni Estensioni da aggiungere o aggiornare nel cluster. string[]
externalGossipCertificates Elenco dei certificati TLS usati per autorizzare gossip da data center non gestiti. I certificati TLS di tutti i nodi nei data center non gestiti devono essere verificabili usando uno dei certificati forniti in questa proprietà. Certificato[]
externalSeedNodes Elenco degli indirizzi IP dei nodi di inizializzazione nei data center non gestiti. Verranno aggiunti agli elenchi di nodi di inizializzazione di tutti i nodi gestiti. SeedNode[]
hoursBetweenBackups (Deprecato) Numero di ore di attesa tra l'esecuzione di un backup del cluster. INT
initialCassandraAdminPassword Password iniziale per i client che si connettono come amministratore al cluster. Deve essere modificato dopo la creazione del cluster. Restituisce Null in GET. Questo campo si applica solo quando il campo authenticationMethod è "Cassandra". string

Vincoli:
Valore sensibile. Passare come parametro sicuro.
prometheusEndpoint Nome host o indirizzo IP in cui è possibile raggiungere l'endpoint Prometheus contenente dati sui nodi Cassandra gestiti. SeedNode
provisionError Errore correlato al provisioning delle risorse. CassandraError
provisioningState Stato della risorsa al momento della chiamata dell'operazione. "Annullata"
"Creazione"
"Eliminazione"
"Non riuscito"
"Riuscito"
"Aggiornamento"
repairEnabled Le riparazioni automatiche devono essere eseguite in questo cluster? Se omesso, questo è vero e dovrebbe rimanere true a meno che non si esegue un cluster ibrido in cui si sta già eseguendo le proprie riparazioni. bool
restoreFromBackupId Per creare un cluster vuoto, omettere questo campo o impostarlo su Null. Per ripristinare un backup in un nuovo cluster, impostare questo campo sull'ID risorsa del backup. string

BackupSchedule

Nome Descrizione Valore
cronExpression Espressione cron che definisce quando si desidera eseguire il backup dei dati. string
retentionInHours Periodo di conservazione (ore) dei backup. Se si desidera conservare i dati per sempre, impostare la conservazione su 0. INT
scheduleName Identificatore univoco della pianificazione del backup. string

Certificato

Nome Descrizione Valore
Pem Chiave pubblica formattata PEM. string

SeedNode

Nome Descrizione Valore
IpAddress Indirizzo IP di questo nodo di inizializzazione. string

CassandraError

Nome Descrizione Valore
additionalErrorInfo Informazioni aggiuntive sull'errore. string
codice Codice di errore che si è verificato. string
message Messaggio dell'errore. string
target Risorsa di destinazione dell'errore. string