Condividi tramite

Microsoft.DocumentDB cassandraClusters 2021-03-01-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@2021-03-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'
  }
}

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. ManagedServiceIdentity
properties Proprietà di un cluster Cassandra gestito. ClusterResourceProperties

ManagedServiceIdentity

Nome Descrizione Valore
tipo 'Nessuno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned': tipo di identità utilizzata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'Nessuno' rimuoverà le identità dal servizio.
userAssignedIdentities Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel modulo: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

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'
'Nessuno'
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 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à. string
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
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 Numero di ore di attesa tra l'esecuzione di un backup del cluster. Per disabilitare i backup, impostare questa proprietà su 0. 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
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

Certificato

Nome Descrizione Valore
Pem Chiave pubblica in formato PEM. string

SeedNode

Nome Descrizione Valore
IpAddress Indirizzo IP di questo nodo di inizializzazione. 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": "2021-03-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"
  }
}

Valori delle proprietà

cassandraClusters

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.DocumentDB/cassandraClusters'
apiVersion Versione dell'API della risorsa '2021-03-01-preview'
name Nome della risorsa stringa (obbligatorio)
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 correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB". Dizionario di nomi e valori di tag. Vedere Tag nei modelli
identity Identità per la risorsa. ManagedServiceIdentity
properties Proprietà di un cluster Cassandra gestito. ClusterResourceProperties

ManagedServiceIdentity

Nome Descrizione Valore
tipo 'Nessuno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned': tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio.
userAssignedIdentities Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

ClusterResourceProperties

Nome Descrizione Valore
authenticationMethod Metodo di autenticazione che Cassandra deve usare per autenticare i client. "Nessuno" disattiva l'autenticazione, quindi non deve essere usata ad eccezione delle emergenze. 'Cassandra' è l'autenticazione predefinita basata su password. Il valore predefinito è "Cassandra". 'Cassandra'
'Nessuno'
cassandraVersion Quale versione di Cassandra deve convergere con l'esecuzione di questo cluster (ad esempio, 3.11). Quando viene aggiornato, la migrazione del cluster alla nuova versione potrebbe richiedere del tempo. string
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à. string
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
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 Numero di ore di attesa tra l'esecuzione di un backup del cluster. Per disabilitare i backup, impostare questa proprietà su 0. 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
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

Certificato

Nome Descrizione Valore
Pem Chiave pubblica in formato PEM. string

SeedNode

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

Definizione della risorsa Terraform (provider AzAPI)

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

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

Valori delle proprietà

cassandraClusters

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.DocumentDB/cassandraClusters@2021-03-01-preview"
name Nome della risorsa stringa (obbligatoria)
posizione Posizione del gruppo di risorse a cui appartiene la risorsa. string
parent_id Per distribuire in un gruppo di risorse, usare l'ID del gruppo di risorse. stringa (obbligatoria)
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. ManagedServiceIdentity
properties Proprietà di un cluster Cassandra gestito. ClusterResourceProperties

ManagedServiceIdentity

Nome Descrizione Valore
tipo "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned": tipo di identità utilizzata per la risorsa. Il tipo "SystemAssigned,UserAssigned" include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio.
identity_ids Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel modulo: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Matrice di ID identità utente.

ManagedServiceIdentityUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

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"
"None"
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
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
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 Numero di ore di attesa tra l'esecuzione di un backup del cluster. Per disabilitare i backup, impostare questa proprietà su 0. 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
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

Certificato

Nome Descrizione Valore
Pem Chiave pubblica formattata PEM. string

SeedNode

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