Share via

CassandraClusters/dataCenters Microsoft.DocumentDB 2023-11-15

  • Article

Définition de ressource Bicep

Le type de ressource cassandraClusters/dataCenters 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/dataCenters, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-11-15' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    authenticationMethodLdapProperties: {
      connectionTimeoutInMs: int
      searchBaseDistinguishedName: 'string'
      searchFilterTemplate: 'string'
      serverCertificates: [
        {
          pem: 'string'
        }
      ]
      serverHostname: 'string'
      serverPort: int
      serviceUserDistinguishedName: 'string'
      serviceUserPassword: 'string'
    }
    availabilityZone: bool
    backupStorageCustomerKeyUri: 'string'
    base64EncodedCassandraYamlFragment: 'string'
    dataCenterLocation: 'string'
    deallocated: bool
    delegatedSubnetId: 'string'
    diskCapacity: int
    diskSku: 'string'
    managedDiskCustomerKeyUri: 'string'
    nodeCount: int
    provisionError: {
      additionalErrorInfo: 'string'
      code: 'string'
      message: 'string'
      target: 'string'
    }
    provisioningState: 'string'
    sku: 'string'
  }
}

Valeurs de propriétés

cassandraClusters/dataCenters

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.		 chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : cassandraClusters
properties Propriétés d’un centre de données Cassandra managé. DataCenterResourceProperties

DataCenterResourceProperties

Nom Description Valeur
authenticationMethodLdapProperties Propriétés de la méthode d’authentification Ldap. Cette fonctionnalité est en préversion. AuthenticationMethodLdapProperties
availabilityZone Si le centre de données prend en charge la zone de disponibilité, appliquez-le au Groupe de machines virtuelles ScaleSet qui héberge les machines virtuelles du centre de données cassandra. bool
backupStorageCustomerKeyUri Indique l’URI de clé de la clé client à utiliser pour le chiffrement du compte de stockage de sauvegarde. string
base64EncodedCassandraYamlFragment Fragment d’un fichier de configuration cassandra.yaml à inclure dans cassandra.yaml pour tous les nœuds de ce centre de données. Le fragment doit être encodé en Base64 et seul un sous-ensemble de clés est autorisé. string
dataCenterLocation Région dans laquelle ce centre de données doit être créé. string
libéré Indique si le centre de données a été libéré. bool
delegatedSubnetId ID de ressource d’un sous-réseau auquel les nœuds de ce centre de données doivent avoir leurs interfaces réseau connectées. Le sous-réseau doit se trouver dans la même région spécifiée dans « dataCenterLocation » et doit être en mesure d’acheminer vers le sous-réseau spécifié dans la propriété « delegatedManagementSubnetId » du cluster. Cet ID de ressource se présente sous la forme « /subscriptions/{id d’abonnement}/resourceGroups/{groupe de ressources}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet} ». string
diskCapacité Nombre de disques attachés à chaque nœud. La valeur par défaut est 4. int
diskSku Référence SKU de disque utilisée pour les centres de données. La valeur par défaut est P30. string
managedDiskCustomerKeyUri URI de clé à utiliser pour le chiffrement des disques managés. Vérifiez que l’identité affectée par le système du cluster a reçu les autorisations appropriées (autorisations d’obtention/d’annulation/de retour de clé) sur la clé. string
nodeCount Nombre de nœuds que le centre de données doit avoir. Il s’agit du nombre souhaité. Une fois qu’il est défini, la mise à l’échelle du centre de données peut prendre un certain temps. Pour surveiller le nombre de nœuds et leur status, utilisez la méthode fetchNodeStatus sur le cluster. int
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'
sku Référence SKU de machine virtuelle utilisée pour les centres de données. La valeur par défaut est Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Nom Description Valeur
connectionTimeoutInMs Délai de connexion au serveur LDAP en milisecondes. La valeur par défaut est de 5 000 ms. int
searchBaseDistinguishedName Nom unique de l’objet à partir duquel démarrer la recherche récursive des utilisateurs. string
searchFilterTemplate Modèle à utiliser pour la recherche. La valeur par défaut est (cn=%s), où %s sera remplacé par le nom d’utilisateur utilisé pour la connexion. string
serverCertificates Certificate[]
serverHostname Nom d’hôte du serveur LDAP. string
serverPort Port du serveur LDAP. int
serviceUserDistinguishedName Nom unique du compte d’utilisateur de recherche, qui peut rechercher les détails de l’utilisateur sur l’authentification. string
serviceUserPassword Mot de passe de l’utilisateur de recherche. string

Certificat

Nom Description Valeur
Pem Clé publique au format PEM. 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/dataCenters 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/dataCenters, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "apiVersion": "2023-11-15",
  "name": "string",
  "properties": {
    "authenticationMethodLdapProperties": {
      "connectionTimeoutInMs": "int",
      "searchBaseDistinguishedName": "string",
      "searchFilterTemplate": "string",
      "serverCertificates": [
        {
          "pem": "string"
        }
      ],
      "serverHostname": "string",
      "serverPort": "int",
      "serviceUserDistinguishedName": "string",
      "serviceUserPassword": "string"
    },
    "availabilityZone": "bool",
    "backupStorageCustomerKeyUri": "string",
    "base64EncodedCassandraYamlFragment": "string",
    "dataCenterLocation": "string",
    "deallocated": "bool",
    "delegatedSubnetId": "string",
    "diskCapacity": "int",
    "diskSku": "string",
    "managedDiskCustomerKeyUri": "string",
    "nodeCount": "int",
    "provisionError": {
      "additionalErrorInfo": "string",
      "code": "string",
      "message": "string",
      "target": "string"
    },
    "provisioningState": "string",
    "sku": "string"
  }
}

Valeurs de propriétés

cassandraClusters/dataCenters

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/cassandraClusters/dataCenters »
apiVersion Version de l’API de ressource '2023-11-15'
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.		 chaîne (obligatoire)
properties Propriétés d’un centre de données Cassandra managé. DataCenterResourceProperties

DataCenterResourceProperties

Nom Description Valeur
authenticationMethodLdapProperties Propriétés de la méthode d’authentification Ldap. Cette fonctionnalité est en préversion. AuthenticationMethodLdapProperties
availabilityZone Si le centre de données prend en charge la zone de disponibilité, appliquez-le au Groupe de machines virtuelles ScaleSet qui héberge les machines virtuelles du centre de données cassandra. bool
backupStorageCustomerKeyUri Indique l’URI de clé de la clé client à utiliser pour le chiffrement du compte de stockage de sauvegarde. string
base64EncodedCassandraYamlFragment Fragment d’un fichier de configuration cassandra.yaml à inclure dans cassandra.yaml pour tous les nœuds de ce centre de données. Le fragment doit être encodé en Base64 et seul un sous-ensemble de clés est autorisé. string
dataCenterLocation Région dans laquelle ce centre de données doit être créé. string
désalloué Indique si le centre de données a été libéré. bool
delegatedSubnetId ID de ressource d’un sous-réseau auquel les nœuds de ce centre de données doivent avoir leurs interfaces réseau connectées. Le sous-réseau doit se trouver dans la même région spécifiée dans « dataCenterLocation » et doit être en mesure d’acheminer vers le sous-réseau spécifié dans la propriété « delegatedManagementSubnetId » du cluster. Cet ID de ressource se présente sous la forme « /subscriptions/{id d’abonnement}/resourceGroups/{groupe de ressources}/providers/Microsoft.Network/virtualNetworks/{virtual Network}/subnets/{subnet} ». string
diskCapacity Nombre de disques attachés à chaque nœud. La valeur par défaut est 4. int
diskSku Référence SKU de disque utilisée pour les centres de données. La valeur par défaut est P30. string
managedDiskCustomerKeyUri URI de clé à utiliser pour le chiffrement des disques managés. Vérifiez que l’identité affectée par le système du cluster a reçu les autorisations appropriées (autorisations de clé get/wrap/unwrap) sur la clé. string
nodeCount Nombre de nœuds que le centre de données doit avoir. Il s’agit du nombre souhaité. Une fois qu’il est défini, la mise à l’échelle du centre de données peut prendre un certain temps. Pour surveiller le nombre de nœuds et leur status, utilisez la méthode fetchNodeStatus sur le cluster. int
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'
sku Référence SKU de machine virtuelle utilisée pour les centres de données. La valeur par défaut est Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Nom Description Valeur
connectionTimeoutInMs Délai d’expiration pour la connexion au serveur LDAP en milisecondes. La valeur par défaut est 5 000 ms. int
searchBaseDistinguishedName Nom unique de l’objet à partir duquel démarrer la recherche récursive des utilisateurs. string
searchFilterTemplate Modèle à utiliser pour la recherche. La valeur par défaut est (cn=%s), où %s est remplacé par le nom d’utilisateur utilisé pour la connexion. string
serverCertificates Certificate[]
serverHostname Nom d’hôte du serveur LDAP. string
serverPort Port du serveur LDAP. int
serviceUserDistinguishedName Nom unique du compte d’utilisateur de recherche, qui peut rechercher les détails de l’utilisateur sur l’authentification. string
serviceUserPassword Mot de passe de l’utilisateur de recherche. string

Certificat

Nom Description Valeur
Pem Clé publique au format PEM. 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/dataCenters 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/dataCenters, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-11-15"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      authenticationMethodLdapProperties = {
        connectionTimeoutInMs = int
        searchBaseDistinguishedName = "string"
        searchFilterTemplate = "string"
        serverCertificates = [
          {
            pem = "string"
          }
        ]
        serverHostname = "string"
        serverPort = int
        serviceUserDistinguishedName = "string"
        serviceUserPassword = "string"
      }
      availabilityZone = bool
      backupStorageCustomerKeyUri = "string"
      base64EncodedCassandraYamlFragment = "string"
      dataCenterLocation = "string"
      deallocated = bool
      delegatedSubnetId = "string"
      diskCapacity = int
      diskSku = "string"
      managedDiskCustomerKeyUri = "string"
      nodeCount = int
      provisionError = {
        additionalErrorInfo = "string"
        code = "string"
        message = "string"
        target = "string"
      }
      provisioningState = "string"
      sku = "string"
    }
  })
}

Valeurs de propriétés

cassandraClusters/dataCenters

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-11-15 »
name Nom de la ressource string (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID pour la ressource de type : cassandraClusters
properties Propriétés d’un centre de données Cassandra managé. DataCenterResourceProperties

DataCenterResourceProperties

Nom Description Valeur
authenticationMethodLdapProperties Propriétés de la méthode d’authentification Ldap. Cette fonctionnalité est en préversion. AuthenticationMethodLdapProperties
availabilityZone Si le centre de données prend en charge la zone de disponibilité, appliquez-la au Groupe de machines virtuelles identiques qui hébergent les machines virtuelles du centre de données cassandra. bool
backupStorageCustomerKeyUri Indique l’URI de clé de la clé client à utiliser pour le chiffrement du compte de stockage de sauvegarde. string
base64EncodedCassandraYamlFragment Fragment d’un fichier de configuration cassandra.yaml à inclure dans cassandra.yaml pour tous les nœuds de ce centre de données. Le fragment doit être encodé en Base64 et seul un sous-ensemble de clés est autorisé. string
dataCenterLocation Région dans laquelle ce centre de données doit être créé. string
désalloué Indique si le centre de données a été libéré. bool
delegatedSubnetId ID de ressource d’un sous-réseau auquel les nœuds de ce centre de données doivent avoir leurs interfaces réseau connectées. Le sous-réseau doit se trouver dans la même région spécifiée dans « dataCenterLocation » et doit être en mesure d’acheminer vers le sous-réseau spécifié dans la propriété « delegatedManagementSubnetId » du cluster. Cet ID de ressource se présente sous la forme « /subscriptions/{id d’abonnement}/resourceGroups/{groupe de ressources}/providers/Microsoft.Network/virtualNetworks/{virtual Network}/subnets/{subnet} ». string
diskCapacity Nombre de disques attachés à chaque nœud. La valeur par défaut est 4. int
diskSku Référence SKU de disque utilisée pour les centres de données. La valeur par défaut est P30. string
managedDiskCustomerKeyUri URI de clé à utiliser pour le chiffrement des disques managés. Vérifiez que l’identité affectée par le système du cluster a reçu les autorisations appropriées (autorisations de clé get/wrap/unwrap) sur la clé. string
nodeCount Nombre de nœuds que le centre de données doit avoir. Il s’agit du nombre souhaité. Une fois qu’il est défini, la mise à l’échelle du centre de données peut prendre un certain temps. Pour surveiller le nombre de nœuds et leur status, utilisez la méthode fetchNodeStatus sur le cluster. int
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 »
sku Référence SKU de machine virtuelle utilisée pour les centres de données. La valeur par défaut est Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Nom Description Valeur
connectionTimeoutInMs Délai d’expiration pour la connexion au serveur LDAP en milisecondes. La valeur par défaut est 5 000 ms. int
searchBaseDistinguishedName Nom unique de l’objet à partir duquel démarrer la recherche récursive des utilisateurs. string
searchFilterTemplate Modèle à utiliser pour la recherche. La valeur par défaut est (cn=%s), où %s sera remplacé par le nom d’utilisateur utilisé pour la connexion. string
serverCertificates Certificate[]
serverHostname Nom d’hôte du serveur LDAP. string
serverPort Port du serveur LDAP. int
serviceUserDistinguishedName Nom unique du compte d’utilisateur de recherche, qui peut rechercher les détails de l’utilisateur sur l’authentification. string
serviceUserPassword Mot de passe de l’utilisateur de recherche. string

Certificat

Nom Description Valeur
Pem Clé publique au format PEM. 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