Share via

Microsoft.DocumentDB cassandraClusters 2023-11-15

  • Article

Définition de ressource Bicep

Le type de ressource cassandraClusters peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DocumentDB/cassandraClusters, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2023-11-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: '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'
  }
}

Valeurs de propriétés

cassandraClusters

Nom Description Valeur
name Nom de la ressource string (obligatoire)
location Emplacement du groupe de ressources auquel appartient la ressource. string
tags Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
identité Identité de la ressource. ManagedCassandraManagedServiceIdentity
properties Propriétés d’un cluster Cassandra managé. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nom Description Valeur
type Type de la ressource. 'None'
'SystemAssigned'

ClusterResourceProperties

Nom Description Valeur
authenticationMethod Quelle méthode d’authentification Cassandra doit utiliser pour authentifier les clients. « Aucun » désactive l’authentification, donc ne doit pas être utilisé, sauf en cas d’urgence. « Cassandra » est l’authentification par mot de passe par défaut. La valeur par défaut est « Cassandra ». 'Cassandra'
'Ldap'
'None'
cassandraAuditLoggingEnabled Si la journalisation d’audit Cassandra est activée bool
cassandraVersion Quelle version de Cassandra ce cluster doit-il converger vers l’exécution (par exemple, 3.11). Une fois mis à jour, la migration du cluster vers la nouvelle version peut prendre un certain temps. string
clientCertificates Liste des certificats TLS utilisés pour autoriser les clients à se connecter au cluster. Toutes les connexions sont chiffrées TLS, que clientCertificates soit défini ou non, mais si clientCertificates est défini, le cluster Cassandra managé rejette toutes les connexions ne portant pas de certificat client TLS qui peuvent être validées à partir d’un ou plusieurs certificats publics dans cette propriété. Certificate[]
clusterNameOverride Si vous devez définir la propriété clusterName dans cassandra.yaml sur quelque chose d’autre que le nom de ressource du cluster, définissez la valeur à utiliser sur cette propriété. string
désalloué Indique si le cluster et les centres de données associés ont été libérés. bool
delegatedManagementSubnetId ID de ressource d’un sous-réseau auquel l’interface réseau du service de gestion de ce cluster doit être attachée. Le sous-réseau doit être routable vers tous les sous-réseaux qui seront délégués aux centres de données. L’ID de ressource doit avoir la forme « /subscriptions/{id d’abonnement}/resourceGroups/{groupe de ressources}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet} » string
externalGossipCertificates Liste des certificats TLS utilisés pour autoriser les ragots à partir de centres de données non managés. Les certificats TLS de tous les nœuds des centres de données non managés doivent être vérifiables à l’aide de l’un des certificats fournis dans cette propriété. Certificate[]
externalSeedNodes Liste des adresses IP des nœuds initiaux dans les centres de données non managés. Ceux-ci seront ajoutés aux listes de nœuds de départ de tous les nœuds managés. SeedNode[]
hoursBetweenBackups (Déconseillé) Nombre d’heures d’attente entre la sauvegarde du cluster. int
initialCassandraAdminPassword Mot de passe initial pour les clients qui se connectent en tant qu’administrateur au cluster. Doit être modifié après la création du cluster. Retourne la valeur null sur GET. Ce champ s’applique uniquement lorsque le champ authenticationMethod est « Cassandra ». string

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.
prometheusEndpoint Nom d’hôte ou adresse IP où le point de terminaison Prometheus contenant des données sur les nœuds Cassandra managés peut être atteint. SeedNode
provisionError Erreur liée à l’approvisionnement des ressources. CassandraError
provisioningState Status de la ressource au moment de l’appel de l’opération. 'Annulé'
'Création'
'Suppression'
'Échec'
'Réussi'
'Mise à jour'
repairEnabled Les réparations automatiques doivent-elles s’exécuter sur ce cluster ? S’il est omis, cette valeur est vraie et doit rester vraie, sauf si vous exécutez un cluster hybride sur lequel vous effectuez déjà vos propres réparations. bool
restoreFromBackupId Pour créer un cluster vide, omettez ce champ ou définissez-le sur null. Pour restaurer une sauvegarde dans un nouveau cluster, définissez ce champ sur l’ID de ressource de la sauvegarde. string

Certificat

Nom Description Valeur
Pem Clé publique au format PEM. string

SeedNode

Nom Description Valeur
ipAddress Adresse IP de ce nœud initial. string

CassandraError

Nom Description Valeur
additionalErrorInfo Informations supplémentaires sur l’erreur. string
code Code d’erreur qui s’est produit. string
message Message de l’erreur. string
target Ressource cible de l’erreur. string

Définition de ressources de modèle ARM

Le type de ressource cassandraClusters peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DocumentDB/cassandraClusters, ajoutez le CODE JSON suivant à votre modèle.

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2023-11-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "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"
  }
}

Valeurs de propriétés

cassandraClusters

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/cassandraClusters »
apiVersion Version de l’API de ressource '2023-11-15'
name Nom de la ressource chaîne (obligatoire)
location Emplacement du groupe de ressources auquel appartient la ressource. string
tags Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
identité Identité de la ressource. ManagedCassandraManagedServiceIdentity
properties Propriétés d’un cluster Cassandra managé. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nom Description Valeur
type Type de la ressource. 'None'
'SystemAssigned'

ClusterResourceProperties

Nom Description Valeur
authenticationMethod Quelle méthode d’authentification Cassandra doit utiliser pour authentifier les clients. « Aucun » désactive l’authentification, donc ne doit pas être utilisé, sauf en cas d’urgence. « Cassandra » est l’authentification par mot de passe par défaut. La valeur par défaut est « Cassandra ». 'Cassandra'
'Ldap'
'None'
cassandraAuditLoggingEnabled Si la journalisation d’audit Cassandra est activée bool
cassandraVersion Quelle version de Cassandra ce cluster doit-il converger vers l’exécution (par exemple, 3.11). Une fois mis à jour, la migration du cluster vers la nouvelle version peut prendre un certain temps. string
clientCertificates Liste des certificats TLS utilisés pour autoriser les clients à se connecter au cluster. Toutes les connexions sont chiffrées TLS, que clientCertificates soit défini ou non, mais si clientCertificates est défini, le cluster Cassandra managé rejette toutes les connexions ne portant pas de certificat client TLS qui peuvent être validées à partir d’un ou plusieurs certificats publics dans cette propriété. Certificate[]
clusterNameOverride Si vous devez définir la propriété clusterName dans cassandra.yaml sur quelque chose d’autre que le nom de ressource du cluster, définissez la valeur à utiliser sur cette propriété. string
désalloué Indique si le cluster et les centres de données associés ont été libérés. bool
delegatedManagementSubnetId ID de ressource d’un sous-réseau auquel l’interface réseau du service de gestion de ce cluster doit être attachée. Le sous-réseau doit être routable vers tous les sous-réseaux qui seront délégués aux centres de données. L’ID de ressource doit avoir la forme « /subscriptions/{id d’abonnement}/resourceGroups/{groupe de ressources}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet} » string
externalGossipCertificates Liste des certificats TLS utilisés pour autoriser les potins à partir de centres de données non gérés. Les certificats TLS de tous les nœuds des centres de données non gérés doivent être vérifiables à l’aide de l’un des certificats fournis dans cette propriété. Certificate[]
externalSeedNodes Liste des adresses IP des nœuds initiaux dans les centres de données non gérés. Ceux-ci seront ajoutés aux listes de nœuds de départ de tous les nœuds managés. SeedNode[]
hoursBetweenBackups (Déconseillé) Nombre d’heures d’attente entre la sauvegarde du cluster. int
initialCassandraAdminPassword Mot de passe initial pour les clients qui se connectent en tant qu’administrateur au cluster. Doit être modifié après la création du cluster. Retourne null sur GET. Ce champ s’applique uniquement lorsque le champ authenticationMethod est « Cassandra ». string

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.
prometheusEndpoint Nom d’hôte ou adresse IP où le point de terminaison Prometheus contenant des données sur les nœuds Cassandra managés peut être atteint. SeedNode
provisionError Erreur liée à l’approvisionnement des ressources. CassandraError
provisioningState Status de la ressource au moment de l’appel de l’opération. 'Canceled'
'Création'
'Suppression'
'Failed'
'Succeeded'
'Mise à jour'
repairEnabled Les réparations automatiques doivent-elles s’exécuter sur ce cluster ? S’il est omis, cela est vrai et doit rester vrai, sauf si vous exécutez un cluster hybride dans lequel vous effectuez déjà vos propres réparations. bool
restoreFromBackupId Pour créer un cluster vide, omettez ce champ ou définissez-le sur null. Pour restaurer une sauvegarde dans un nouveau cluster, définissez ce champ sur l’ID de ressource de la sauvegarde. string

Certificat

Nom Description Valeur
Pem Clé publique au format PEM. string

SeedNode

Nom Description Valeur
ipAddress Adresse IP de ce nœud initial. string

CassandraError

Nom Description Valeur
additionalErrorInfo Informations supplémentaires sur l’erreur. string
code Code d’erreur qui s’est produit. string
message Message de l’erreur. string
target Ressource cible de l’erreur. string

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource cassandraClusters peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DocumentDB/cassandraClusters, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2023-11-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  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"
    }
  })
}

Valeurs de propriétés

cassandraClusters

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/cassandraClusters@2023-11-15 »
name Nom de la ressource string (obligatoire)
location Emplacement du groupe de ressources auquel appartient la ressource. string
parent_id Pour effectuer un déploiement dans un groupe de ressources, utilisez l’ID de ce groupe de ressources. string (obligatoire)
tags Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». Dictionnaire de noms et de valeurs d’étiquettes.
identité Identité de la ressource. ManagedCassandraManagedServiceIdentity
properties Propriétés d’un cluster Cassandra managé. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nom Description Valeur
type Type de la ressource. « SystemAssigned »

ClusterResourceProperties

Nom Description Valeur
authenticationMethod Quelle méthode d’authentification Cassandra doit utiliser pour authentifier les clients. « Aucun » désactive l’authentification, donc ne doit pas être utilisé, sauf en cas d’urgence. « Cassandra » est l’authentification par mot de passe par défaut. La valeur par défaut est « Cassandra ». « Cassandra »
« Ldap »
"None"
cassandraAuditLoggingEnabled Si la journalisation d’audit Cassandra est activée bool
cassandraVersion Quelle version de Cassandra ce cluster doit-il converger vers l’exécution (par exemple, 3.11). Une fois mis à jour, la migration du cluster vers la nouvelle version peut prendre un certain temps. string
clientCertificates Liste des certificats TLS utilisés pour autoriser les clients à se connecter au cluster. Toutes les connexions sont chiffrées TLS, que clientCertificates soit défini ou non, mais si clientCertificates est défini, le cluster Cassandra managé rejette toutes les connexions ne portant pas de certificat client TLS qui peuvent être validées à partir d’un ou plusieurs certificats publics dans cette propriété. Certificate[]
clusterNameOverride Si vous devez définir la propriété clusterName dans cassandra.yaml sur quelque chose d’autre que le nom de ressource du cluster, définissez la valeur à utiliser sur cette propriété. string
désalloué Indique si le cluster et les centres de données associés ont été libérés. bool
delegatedManagementSubnetId ID de ressource d’un sous-réseau auquel l’interface réseau du service de gestion de ce cluster doit être attachée. Le sous-réseau doit être routable vers tous les sous-réseaux qui seront délégués aux centres de données. L’ID de ressource doit avoir la forme « /subscriptions/{id d’abonnement}/resourceGroups/{groupe de ressources}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet} » string
externalGossipCertificates Liste des certificats TLS utilisés pour autoriser les potins à partir de centres de données non gérés. Les certificats TLS de tous les nœuds des centres de données non gérés doivent être vérifiables à l’aide de l’un des certificats fournis dans cette propriété. Certificate[]
externalSeedNodes Liste des adresses IP des nœuds initiaux dans les centres de données non gérés. Ceux-ci seront ajoutés aux listes de nœuds de départ de tous les nœuds managés. SeedNode[]
hoursBetweenBackups (Déconseillé) Nombre d’heures d’attente entre la sauvegarde du cluster. int
initialCassandraAdminPassword Mot de passe initial pour les clients qui se connectent en tant qu’administrateur au cluster. Doit être modifié après la création du cluster. Retourne null sur GET. Ce champ s’applique uniquement lorsque le champ authenticationMethod est « Cassandra ». string

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.
prometheusEndpoint Nom d’hôte ou adresse IP où le point de terminaison Prometheus contenant des données sur les nœuds Cassandra managés peut être atteint. SeedNode
provisionError Erreur liée à l’approvisionnement des ressources. CassandraError
provisioningState Status de la ressource au moment de l’appel de l’opération. « Annulé »
« Création »
« Suppression »
« Échec »
« Réussi »
« Mise à jour »
repairEnabled Les réparations automatiques doivent-elles s’exécuter sur ce cluster ? S’il est omis, cela est vrai et doit rester vrai, sauf si vous exécutez un cluster hybride dans lequel vous effectuez déjà vos propres réparations. bool
restoreFromBackupId Pour créer un cluster vide, omettez ce champ ou définissez-le sur null. Pour restaurer une sauvegarde dans un nouveau cluster, définissez ce champ sur l’ID de ressource de la sauvegarde. string

Certificat

Nom Description Valeur
Pem Clé publique au format PEM. string

SeedNode

Nom Description Valeur
ipAddress Adresse IP de ce nœud initial. string

CassandraError

Nom Description Valeur
additionalErrorInfo Informations supplémentaires sur l’erreur. string
code Code d’erreur qui s’est produit. string
message Message de l’erreur. string
target Ressource cible de l’erreur. string