Partager via

Microsoft.DocumentDB cassandraClusters 2023-09-15-preview

  • 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 de l’API, consultez journal des modifications.

Format de ressource

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

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: '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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

BackupSchedule

Nom Description Valeur
cronExpression Expression cron qui définit quand vous souhaitez sauvegarder vos données. corde
retentionInHours Période de rétention (heures) des sauvegardes. Si vous souhaitez conserver les données à jamais, définissez la rétention sur 0. Int
scheduleName Identificateur unique de la planification de sauvegarde. corde

CassandraError

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

Certificat

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

ClusterResourceProperties

Nom Description Valeur
authenticationMethod Quelle méthode d’authentification Cassandra doit utiliser pour authentifier les clients. « Aucun » désactive l’authentification. Il ne doit donc pas être utilisé en cas d’urgence. « Cassandra » est l’authentification par défaut basée sur le mot de passe. La valeur par défaut est « Cassandra ». 'Cassandra'
'Ldap'
'None'
backupSchedules Liste des planifications de sauvegarde qui définissent quand vous souhaitez sauvegarder vos données. BackupSchedule[]
cassandraAuditLoggingEnabled Indique si la journalisation de l’audit Cassandra est activée Bool
cassandraVersion Quelle version de Cassandra doit converger vers l’exécution (par exemple, 3.11). Lors de la mise à jour, le cluster peut prendre un certain temps pour migrer vers la nouvelle version. corde
clientCertificates Liste des certificats TLS utilisés pour autoriser les clients qui se connectent au cluster. Toutes les connexions sont chiffrées par TLS si clientCertificates est 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 peut être validé à partir d’un ou plusieurs des certificats publics de cette propriété. certificat[]
clusterNameOverride Si vous devez définir la propriété clusterName dans cassandra.yaml sur quelque chose en plus du nom de ressource du cluster, définissez la valeur à utiliser sur cette propriété. corde
clusterType Type du cluster. Si elle est définie sur Production, certaines opérations peuvent ne pas être autorisées sur le cluster. 'NonProduction'
'Production'
désallouée 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 le service de gestion de ce cluster doit avoir son interface réseau 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 être au format « /subscriptions/<id d’abonnement>/resourceGroups/<groupe de ressources>/providers/Microsoft.Network/virtualNetworks/<réseau virtuel>/subnets/<sous-réseau>' corde
Extensions Extensions à ajouter ou à mettre à jour sur le cluster. string[]
externalGossipCertificates Liste des certificats TLS utilisés pour autoriser le gossip à partir de centres de données non gérés. Les certificats TLS de tous les nœuds dans des centres de données non managés doivent être vérifiables à l’aide de l’un des certificats fournis dans cette propriété. certificat[]
externalSeedNodes Liste des adresses IP des nœuds de départ dans des centres de données non gérés. Celles-ci seront ajoutées aux listes de nœuds initiales 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 ». corde

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 au provisionnement des ressources. CassandraError
provisioningState État 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 où 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. corde

ManagedCassandraManagedServiceIdentity

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

Microsoft.DocumentDB/cassandraClusters

Nom Description Valeur
identité Identité de la ressource. ManagedCassandraManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (obligatoire)
Propriétés Propriétés d’un cluster Cassandra managé. clusterResourceProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

SeedNode

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

Étiquettes

Nom Description Valeur

Définition de ressource 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 de ressource

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2023-09-15-preview",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

BackupSchedule

Nom Description Valeur
cronExpression Expression cron qui définit quand vous souhaitez sauvegarder vos données. corde
retentionInHours Période de rétention (heures) des sauvegardes. Si vous souhaitez conserver les données à jamais, définissez la rétention sur 0. Int
scheduleName Identificateur unique de la planification de sauvegarde. corde

CassandraError

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

Certificat

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

ClusterResourceProperties

Nom Description Valeur
authenticationMethod Quelle méthode d’authentification Cassandra doit utiliser pour authentifier les clients. « Aucun » désactive l’authentification. Il ne doit donc pas être utilisé en cas d’urgence. « Cassandra » est l’authentification par défaut basée sur le mot de passe. La valeur par défaut est « Cassandra ». 'Cassandra'
'Ldap'
'None'
backupSchedules Liste des planifications de sauvegarde qui définissent quand vous souhaitez sauvegarder vos données. BackupSchedule[]
cassandraAuditLoggingEnabled Indique si la journalisation de l’audit Cassandra est activée Bool
cassandraVersion Quelle version de Cassandra doit converger vers l’exécution (par exemple, 3.11). Lors de la mise à jour, le cluster peut prendre un certain temps pour migrer vers la nouvelle version. corde
clientCertificates Liste des certificats TLS utilisés pour autoriser les clients qui se connectent au cluster. Toutes les connexions sont chiffrées par TLS si clientCertificates est 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 peut être validé à partir d’un ou plusieurs des certificats publics de cette propriété. certificat[]
clusterNameOverride Si vous devez définir la propriété clusterName dans cassandra.yaml sur quelque chose en plus du nom de ressource du cluster, définissez la valeur à utiliser sur cette propriété. corde
clusterType Type du cluster. Si elle est définie sur Production, certaines opérations peuvent ne pas être autorisées sur le cluster. 'NonProduction'
'Production'
désallouée 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 le service de gestion de ce cluster doit avoir son interface réseau 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 être au format « /subscriptions/<id d’abonnement>/resourceGroups/<groupe de ressources>/providers/Microsoft.Network/virtualNetworks/<réseau virtuel>/subnets/<sous-réseau>' corde
Extensions Extensions à ajouter ou à mettre à jour sur le cluster. string[]
externalGossipCertificates Liste des certificats TLS utilisés pour autoriser le gossip à partir de centres de données non gérés. Les certificats TLS de tous les nœuds dans des centres de données non managés doivent être vérifiables à l’aide de l’un des certificats fournis dans cette propriété. certificat[]
externalSeedNodes Liste des adresses IP des nœuds de départ dans des centres de données non gérés. Celles-ci seront ajoutées aux listes de nœuds initiales 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 ». corde

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 au provisionnement des ressources. CassandraError
provisioningState État 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 où 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. corde

ManagedCassandraManagedServiceIdentity

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

Microsoft.DocumentDB/cassandraClusters

Nom Description Valeur
apiVersion Version de l’API '2023-09-15-preview'
identité Identité de la ressource. ManagedCassandraManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (obligatoire)
Propriétés Propriétés d’un cluster Cassandra managé. clusterResourceProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.DocumentDB/cassandraClusters'

SeedNode

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

Étiquettes

Nom Description Valeur

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 de l’API, consultez journal des modifications.

Format de ressource

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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"
    }
  })
}

Valeurs de propriété

BackupSchedule

Nom Description Valeur
cronExpression Expression cron qui définit quand vous souhaitez sauvegarder vos données. corde
retentionInHours Période de rétention (heures) des sauvegardes. Si vous souhaitez conserver les données à jamais, définissez la rétention sur 0. Int
scheduleName Identificateur unique de la planification de sauvegarde. corde

CassandraError

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

Certificat

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

ClusterResourceProperties

Nom Description Valeur
authenticationMethod Quelle méthode d’authentification Cassandra doit utiliser pour authentifier les clients. « Aucun » désactive l’authentification. Il ne doit donc pas être utilisé en cas d’urgence. « Cassandra » est l’authentification par défaut basée sur le mot de passe. La valeur par défaut est « Cassandra ». 'Cassandra'
'Ldap'
'None'
backupSchedules Liste des planifications de sauvegarde qui définissent quand vous souhaitez sauvegarder vos données. BackupSchedule[]
cassandraAuditLoggingEnabled Indique si la journalisation de l’audit Cassandra est activée Bool
cassandraVersion Quelle version de Cassandra doit converger vers l’exécution (par exemple, 3.11). Lors de la mise à jour, le cluster peut prendre un certain temps pour migrer vers la nouvelle version. corde
clientCertificates Liste des certificats TLS utilisés pour autoriser les clients qui se connectent au cluster. Toutes les connexions sont chiffrées par TLS si clientCertificates est 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 peut être validé à partir d’un ou plusieurs des certificats publics de cette propriété. certificat[]
clusterNameOverride Si vous devez définir la propriété clusterName dans cassandra.yaml sur quelque chose en plus du nom de ressource du cluster, définissez la valeur à utiliser sur cette propriété. corde
clusterType Type du cluster. Si elle est définie sur Production, certaines opérations peuvent ne pas être autorisées sur le cluster. 'NonProduction'
'Production'
désallouée 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 le service de gestion de ce cluster doit avoir son interface réseau 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 être au format « /subscriptions/<id d’abonnement>/resourceGroups/<groupe de ressources>/providers/Microsoft.Network/virtualNetworks/<réseau virtuel>/subnets/<sous-réseau>' corde
Extensions Extensions à ajouter ou à mettre à jour sur le cluster. string[]
externalGossipCertificates Liste des certificats TLS utilisés pour autoriser le gossip à partir de centres de données non gérés. Les certificats TLS de tous les nœuds dans des centres de données non managés doivent être vérifiables à l’aide de l’un des certificats fournis dans cette propriété. certificat[]
externalSeedNodes Liste des adresses IP des nœuds de départ dans des centres de données non gérés. Celles-ci seront ajoutées aux listes de nœuds initiales 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 ». corde

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 au provisionnement des ressources. CassandraError
provisioningState État 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 où 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. corde

ManagedCassandraManagedServiceIdentity

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

Microsoft.DocumentDB/cassandraClusters

Nom Description Valeur
identité Identité de la ressource. ManagedCassandraManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (obligatoire)
Propriétés Propriétés d’un cluster Cassandra managé. clusterResourceProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview »

SeedNode

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

Étiquettes

Nom Description Valeur