Microsoft.DocumentDB cassandraClusters/dataCenters 2024-05-15-preview
- dernière
- 2024-12-01-preview
- 2024-11-15
- 2024-09-01-preview
- 2024-08-15
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-04-01-preview
- 2021-03-01-preview
Définition de ressource Bicep
Le type de ressource cassandraClusters/dataCenters peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de 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/dataCenters, ajoutez le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15-preview' = {
parent: resourceSymbolicName
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
privateEndpointIpAddress: 'string'
provisionError: {
additionalErrorInfo: 'string'
code: 'string'
message: 'string'
target: 'string'
}
provisioningState: 'string'
sku: 'string'
}
}
Valeurs de propriété
AuthenticationMethodLdapProperties
| Nom | Description | Valeur |
|---|---|---|
| connectionTimeoutInMs | Délai d’expiration de 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. | corde |
| searchFilterTemplate | Modèle à utiliser pour la recherche. Valeur par défaut (cn=%s) où %s sera remplacé par le nom d’utilisateur utilisé pour se connecter. | corde |
| serverCertificates | certificat[] | |
| serverHostname | Nom d’hôte du serveur LDAP. | corde |
| 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. | corde |
| serviceUserPassword | Mot de passe de l’utilisateur de recherche. | 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 |
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 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. | corde |
| base64EncodedCassandraYamlFragment | Fragment d’un fichier de configuration cassandra.yaml à inclure dans le fichier 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é. | corde |
| dataCenterLocation | La région dans laquelle ce centre de données doit être créé. | corde |
| désallouée | Indique si le centre de données a été libéré. | Bool |
| delegatedSubnetId | L’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/<réseau virtuel>/subnets/<sous-réseau>». | corde |
| 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. | corde |
| 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 été affectée aux autorisations appropriées (autorisations get/wrap/unwrap) appropriées sur la clé. | corde |
| 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, il peut prendre un certain temps pour que le centre de données soit mis à l’échelle pour qu’il corresponde. Pour surveiller le nombre de nœuds et leur état, utilisez la méthode fetchNodeStatus sur le cluster. | Int |
| privateEndpointIpAddress | Adresse IP du point de terminaison VPN pour ce centre de données. | corde |
| 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' |
| 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 | corde |
Microsoft.DocumentDB/cassandraClusters/dataCenters
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (obligatoire) |
| parent | Dans Bicep, vous pouvez spécifier la ressource parente d’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 |
| Propriétés | Propriétés d’un centre de données Cassandra managé. | DataCenterResourceProperties |
Définition de ressource de modèle ARM
Le type de ressource cassandraClusters/dataCenters peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de 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/dataCenters, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
"apiVersion": "2024-05-15-preview",
"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",
"privateEndpointIpAddress": "string",
"provisionError": {
"additionalErrorInfo": "string",
"code": "string",
"message": "string",
"target": "string"
},
"provisioningState": "string",
"sku": "string"
}
}
Valeurs de propriété
AuthenticationMethodLdapProperties
| Nom | Description | Valeur |
|---|---|---|
| connectionTimeoutInMs | Délai d’expiration de 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. | corde |
| searchFilterTemplate | Modèle à utiliser pour la recherche. Valeur par défaut (cn=%s) où %s sera remplacé par le nom d’utilisateur utilisé pour se connecter. | corde |
| serverCertificates | certificat[] | |
| serverHostname | Nom d’hôte du serveur LDAP. | corde |
| 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. | corde |
| serviceUserPassword | Mot de passe de l’utilisateur de recherche. | 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 |
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 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. | corde |
| base64EncodedCassandraYamlFragment | Fragment d’un fichier de configuration cassandra.yaml à inclure dans le fichier 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é. | corde |
| dataCenterLocation | La région dans laquelle ce centre de données doit être créé. | corde |
| désallouée | Indique si le centre de données a été libéré. | Bool |
| delegatedSubnetId | L’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/<réseau virtuel>/subnets/<sous-réseau>». | corde |
| 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. | corde |
| 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 été affectée aux autorisations appropriées (autorisations get/wrap/unwrap) appropriées sur la clé. | corde |
| 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, il peut prendre un certain temps pour que le centre de données soit mis à l’échelle pour qu’il corresponde. Pour surveiller le nombre de nœuds et leur état, utilisez la méthode fetchNodeStatus sur le cluster. | Int |
| privateEndpointIpAddress | Adresse IP du point de terminaison VPN pour ce centre de données. | corde |
| 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' |
| 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 | corde |
Microsoft.DocumentDB/cassandraClusters/dataCenters
| Nom | Description | Valeur |
|---|---|---|
| apiVersion | Version de l’API | '2024-05-15-preview' |
| 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 centre de données Cassandra managé. | DataCenterResourceProperties |
| type | Type de ressource | 'Microsoft.DocumentDB/cassandraClusters/dataCenters' |
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 de l’API, consultez journal des modifications.
Format de ressource
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@2024-05-15-preview"
name = "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
privateEndpointIpAddress = "string"
provisionError = {
additionalErrorInfo = "string"
code = "string"
message = "string"
target = "string"
}
provisioningState = "string"
sku = "string"
}
})
}
Valeurs de propriété
AuthenticationMethodLdapProperties
| Nom | Description | Valeur |
|---|---|---|
| connectionTimeoutInMs | Délai d’expiration de 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. | corde |
| searchFilterTemplate | Modèle à utiliser pour la recherche. Valeur par défaut (cn=%s) où %s sera remplacé par le nom d’utilisateur utilisé pour se connecter. | corde |
| serverCertificates | certificat[] | |
| serverHostname | Nom d’hôte du serveur LDAP. | corde |
| 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. | corde |
| serviceUserPassword | Mot de passe de l’utilisateur de recherche. | 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 |
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 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. | corde |
| base64EncodedCassandraYamlFragment | Fragment d’un fichier de configuration cassandra.yaml à inclure dans le fichier 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é. | corde |
| dataCenterLocation | La région dans laquelle ce centre de données doit être créé. | corde |
| désallouée | Indique si le centre de données a été libéré. | Bool |
| delegatedSubnetId | L’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/<réseau virtuel>/subnets/<sous-réseau>». | corde |
| 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. | corde |
| 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 été affectée aux autorisations appropriées (autorisations get/wrap/unwrap) appropriées sur la clé. | corde |
| 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, il peut prendre un certain temps pour que le centre de données soit mis à l’échelle pour qu’il corresponde. Pour surveiller le nombre de nœuds et leur état, utilisez la méthode fetchNodeStatus sur le cluster. | Int |
| privateEndpointIpAddress | Adresse IP du point de terminaison VPN pour ce centre de données. | corde |
| 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' |
| 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 | corde |
Microsoft.DocumentDB/cassandraClusters/dataCenters
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (obligatoire) |
| parent_id | ID de la ressource qui est le parent de cette ressource. | ID de ressource de type : cassandraClusters |
| Propriétés | Propriétés d’un centre de données Cassandra managé. | DataCenterResourceProperties |
| type | Type de ressource | « Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15-preview » |