Condividi tramite

Microsoft.DocumentDB cassandraClusters 2024-09-01-preview

  • Articolo

Definizione di risorsa Bicep

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

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

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

Formato risorsa

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

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2024-09-01-preview' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    authenticationMethod: 'string'
    autoReplicate: 'string'
    azureConnectionMethod: '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'
    ]
    externalDataCenters: [
      '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'
    scheduledEventStrategy: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valori delle proprietà

BackupSchedule

Nome Descrizione Valore
cronExpression Espressione cron che definisce quando si desidera eseguire il backup dei dati. corda
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. corda

CassandraError

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

Certificato

Nome Descrizione Valore
Pem Chiave pubblica con formattazione PEM. corda

ClusterResourceProperties

Nome Descrizione Valore
authenticationMethod Quale metodo di autenticazione deve usare Cassandra per autenticare i client. "Nessuno" disattiva l'autenticazione, quindi non deve essere usata tranne nelle emergenze. 'Cassandra' è l'autenticazione predefinita basata su password. Il valore predefinito è "Cassandra". 'Cassandra'
'Ldap'
'Nessuno'
replica automatica Forma di replica automatica usata da questo cluster. 'AllKeyspaces'
'Nessuno'
'SystemKeyspaces'
azureConnectionMethod Come connettersi ai servizi di Azure necessari per l'esecuzione del cluster 'Nessuno'
'VPN'
backupSchedules Elenco delle pianificazioni di backup che definiscono quando si vuole eseguire il backup dei dati. BackupSchedule[]
cassandraAuditLoggingEnabled Indica se la registrazione di controllo cassandra è abilitata Bool
cassandraVersion Quale versione di Cassandra deve convergere per l'esecuzione del cluster (ad esempio, 3.11). Quando viene aggiornato, il cluster potrebbe richiedere del tempo per eseguire la migrazione alla nuova versione. corda
clientCertificates Elenco di certificati TLS usati per autorizzare i client che si connettono al cluster. Tutte le connessioni sono crittografate tramite TLS indipendentemente dal fatto che clientCertificates sia impostato o meno, ma se clientCertificates è impostato, il cluster Cassandra gestito rifiuterà tutte le connessioni che non hanno 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 valore diverso dal nome della risorsa del cluster, impostare il valore da usare in questa proprietà. corda
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>' corda
Estensioni Estensioni da aggiungere o aggiornare nel cluster. string[]
externalDataCenters Elenco dei nomi dei data center per i data center non gestiti in questo cluster da includere nella replica automatica. 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 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'. corda

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. 'Annullato'
'Creazione'
'Eliminazione'
'Failed'
'Succeeded'
'Aggiornamento'
repairEnabled Le riparazioni automatiche devono essere eseguite in questo cluster? Se omesso, questo valore è true e deve rimanere true a meno che non si esegua 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. corda
scheduledEventStrategy Come reagiscono i nodi del cluster agli eventi pianificati 'Ignore'
'StopAny'
'StopByRack'

ManagedCassandraManagedServiceIdentity

Nome Descrizione Valore
digitare Tipo della risorsa. 'Nessuno'
'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

Nome Descrizione Valore
identità Identità per la risorsa. ManagedCassandraManagedServiceIdentity
ubicazione Posizione del gruppo di risorse a cui appartiene la risorsa. corda
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (obbligatorio)
proprietà Proprietà di un cluster Cassandra gestito. ClusterResourceProperties
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

SeedNode

Nome Descrizione Valore
ipAddress Indirizzo IP del nodo di inizializzazione. corda

Tag

Nome Descrizione Valore

Definizione di risorsa del modello di Resource Manager

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

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

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

Formato risorsa

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2024-09-01-preview",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "authenticationMethod": "string",
    "autoReplicate": "string",
    "azureConnectionMethod": "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" ],
    "externalDataCenters": [ "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",
    "scheduledEventStrategy": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valori delle proprietà

BackupSchedule

Nome Descrizione Valore
cronExpression Espressione cron che definisce quando si desidera eseguire il backup dei dati. corda
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. corda

CassandraError

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

Certificato

Nome Descrizione Valore
Pem Chiave pubblica con formattazione PEM. corda

ClusterResourceProperties

Nome Descrizione Valore
authenticationMethod Quale metodo di autenticazione deve usare Cassandra per autenticare i client. "Nessuno" disattiva l'autenticazione, quindi non deve essere usata tranne nelle emergenze. 'Cassandra' è l'autenticazione predefinita basata su password. Il valore predefinito è "Cassandra". 'Cassandra'
'Ldap'
'Nessuno'
replica automatica Forma di replica automatica usata da questo cluster. 'AllKeyspaces'
'Nessuno'
'SystemKeyspaces'
azureConnectionMethod Come connettersi ai servizi di Azure necessari per l'esecuzione del cluster 'Nessuno'
'VPN'
backupSchedules Elenco delle pianificazioni di backup che definiscono quando si vuole eseguire il backup dei dati. BackupSchedule[]
cassandraAuditLoggingEnabled Indica se la registrazione di controllo cassandra è abilitata Bool
cassandraVersion Quale versione di Cassandra deve convergere per l'esecuzione del cluster (ad esempio, 3.11). Quando viene aggiornato, il cluster potrebbe richiedere del tempo per eseguire la migrazione alla nuova versione. corda
clientCertificates Elenco di certificati TLS usati per autorizzare i client che si connettono al cluster. Tutte le connessioni sono crittografate tramite TLS indipendentemente dal fatto che clientCertificates sia impostato o meno, ma se clientCertificates è impostato, il cluster Cassandra gestito rifiuterà tutte le connessioni che non hanno 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 valore diverso dal nome della risorsa del cluster, impostare il valore da usare in questa proprietà. corda
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>' corda
Estensioni Estensioni da aggiungere o aggiornare nel cluster. string[]
externalDataCenters Elenco dei nomi dei data center per i data center non gestiti in questo cluster da includere nella replica automatica. 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 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'. corda

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. 'Annullato'
'Creazione'
'Eliminazione'
'Failed'
'Succeeded'
'Aggiornamento'
repairEnabled Le riparazioni automatiche devono essere eseguite in questo cluster? Se omesso, questo valore è true e deve rimanere true a meno che non si esegua 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. corda
scheduledEventStrategy Come reagiscono i nodi del cluster agli eventi pianificati 'Ignore'
'StopAny'
'StopByRack'

ManagedCassandraManagedServiceIdentity

Nome Descrizione Valore
digitare Tipo della risorsa. 'Nessuno'
'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

Nome Descrizione Valore
apiVersion Versione dell'API '2024-09-01-preview'
identità Identità per la risorsa. ManagedCassandraManagedServiceIdentity
ubicazione Posizione del gruppo di risorse a cui appartiene la risorsa. corda
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (obbligatorio)
proprietà Proprietà di un cluster Cassandra gestito. ClusterResourceProperties
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare Tipo di risorsa 'Microsoft.DocumentDB/cassandraClusters'

SeedNode

Nome Descrizione Valore
ipAddress Indirizzo IP del nodo di inizializzazione. corda

Tag

Nome Descrizione Valore

Definizione di 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 risorsa

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2024-09-01-preview"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authenticationMethod = "string"
      autoReplicate = "string"
      azureConnectionMethod = "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"
      ]
      externalDataCenters = [
        "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"
      scheduledEventStrategy = "string"
    }
  })
}

Valori delle proprietà

BackupSchedule

Nome Descrizione Valore
cronExpression Espressione cron che definisce quando si desidera eseguire il backup dei dati. corda
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. corda

CassandraError

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

Certificato

Nome Descrizione Valore
Pem Chiave pubblica con formattazione PEM. corda

ClusterResourceProperties

Nome Descrizione Valore
authenticationMethod Quale metodo di autenticazione deve usare Cassandra per autenticare i client. "Nessuno" disattiva l'autenticazione, quindi non deve essere usata tranne nelle emergenze. 'Cassandra' è l'autenticazione predefinita basata su password. Il valore predefinito è "Cassandra". 'Cassandra'
'Ldap'
'Nessuno'
replica automatica Forma di replica automatica usata da questo cluster. 'AllKeyspaces'
'Nessuno'
'SystemKeyspaces'
azureConnectionMethod Come connettersi ai servizi di Azure necessari per l'esecuzione del cluster 'Nessuno'
'VPN'
backupSchedules Elenco delle pianificazioni di backup che definiscono quando si vuole eseguire il backup dei dati. BackupSchedule[]
cassandraAuditLoggingEnabled Indica se la registrazione di controllo cassandra è abilitata Bool
cassandraVersion Quale versione di Cassandra deve convergere per l'esecuzione del cluster (ad esempio, 3.11). Quando viene aggiornato, il cluster potrebbe richiedere del tempo per eseguire la migrazione alla nuova versione. corda
clientCertificates Elenco di certificati TLS usati per autorizzare i client che si connettono al cluster. Tutte le connessioni sono crittografate tramite TLS indipendentemente dal fatto che clientCertificates sia impostato o meno, ma se clientCertificates è impostato, il cluster Cassandra gestito rifiuterà tutte le connessioni che non hanno 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 valore diverso dal nome della risorsa del cluster, impostare il valore da usare in questa proprietà. corda
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>' corda
Estensioni Estensioni da aggiungere o aggiornare nel cluster. string[]
externalDataCenters Elenco dei nomi dei data center per i data center non gestiti in questo cluster da includere nella replica automatica. 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 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'. corda

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. 'Annullato'
'Creazione'
'Eliminazione'
'Failed'
'Succeeded'
'Aggiornamento'
repairEnabled Le riparazioni automatiche devono essere eseguite in questo cluster? Se omesso, questo valore è true e deve rimanere true a meno che non si esegua 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. corda
scheduledEventStrategy Come reagiscono i nodi del cluster agli eventi pianificati 'Ignore'
'StopAny'
'StopByRack'

ManagedCassandraManagedServiceIdentity

Nome Descrizione Valore
digitare Tipo della risorsa. 'Nessuno'
'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

Nome Descrizione Valore
identità Identità per la risorsa. ManagedCassandraManagedServiceIdentity
ubicazione Posizione del gruppo di risorse a cui appartiene la risorsa. corda
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (obbligatorio)
proprietà Proprietà di un cluster Cassandra gestito. ClusterResourceProperties
Tag Tag delle risorse Dizionario di nomi e valori di tag.
digitare Tipo di risorsa "Microsoft.DocumentDB/cassandraClusters@2024-09-01-preview"

SeedNode

Nome Descrizione Valore
ipAddress Indirizzo IP del nodo di inizializzazione. corda

Tag

Nome Descrizione Valore