Microsoft.DocumentDB mongoClusters

Article
12/18/2024

Définition de ressource Bicep

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

resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2024-10-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    administrator: {
      password: 'string'
      userName: 'string'
    }
    backup: {}
    compute: {
      tier: 'string'
    }
    createMode: 'string'
    dataApi: {
      mode: 'string'
    }
    highAvailability: {
      targetMode: 'string'
    }
    previewFeatures: [
      'string'
    ]
    publicNetworkAccess: 'string'
    replicaParameters: {
      sourceLocation: 'string'
      sourceResourceId: 'string'
    }
    restoreParameters: {
      pointInTimeUTC: 'string'
      sourceResourceId: 'string'
    }
    serverVersion: 'string'
    sharding: {
      shardCount: int
    }
    storage: {
      sizeGb: int
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

AdministratorProperties

Nom	Description	Valeur
mot de passe	Mot de passe administrateur.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
nom d’utilisateur	Nom d’utilisateur administrateur.	corde

BackupProperties

Nom	Description	Valeur

ComputeProperties

Nom	Description	Valeur
niveau	Niveau de calcul à affecter au cluster, où chaque niveau est mappé à une taille de cœur virtuel et de mémoire. Exemples de valeurs : « M30 », « M40 ».	corde

DataApiProperties

Nom	Description	Valeur
mode	Mode pour indiquer si l’API Mongo Data est activée pour un cluster.	'Désactivé' 'Activé'

HighAvailabilityProperties

Nom	Description	Valeur
targetMode	Mode de haute disponibilité cible demandé pour le cluster.	'Désactivé' 'SameZone' 'ZoneRedundantPreferred'

Microsoft.DocumentDB/mongoClusters

Nom	Description	Valeur
emplacement	Emplacement géographique où réside la ressource	chaîne (obligatoire)
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 3 Longueur maximale = 3 Modèle = `^[a-z0-9]+(-[a-z0-9]+)*` (obligatoire)
Propriétés	Propriétés spécifiques à la ressource pour cette ressource.	MongoClusterProperties
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

MongoClusterProperties

Nom	Description	Valeur
administrateur	Propriétés de l’administrateur local pour le cluster mongo.	AdministratorProperties
sauvegarde	Propriétés de sauvegarde du cluster mongo.	BackupProperties
calculer	Propriétés de calcul du cluster mongo.	ComputeProperties
createMode	Mode de création d’un cluster mongo.	'Default' 'GeoReplica' 'PointInTimeRestore' 'Replica'
dataApi	Propriétés de l’API de données du cluster mongo.	DataApiProperties
highAvailability	Propriétés de haute disponibilité du cluster mongo.	HighAvailabilityProperties
previewFeatures	Liste des connexions de point de terminaison privé.	Tableau de chaînes contenant l’un des éléments suivants : 'GeoReplicas'
publicNetworkAccess	Indique si l’accès au point de terminaison public est autorisé pour ce cluster mongo.	'Désactivé' 'Activé'
replicaParameters	Paramètres permettant de créer un cluster mongo de réplica.	MongoClusterReplicaParameters
restoreParameters	Paramètres permettant de créer un cluster mongo de restauration à un point dans le temps.	MongoClusterRestoreParameters
serverVersion	Version du serveur Mongo DB. La valeur par défaut est la dernière version disponible si elle n’est pas spécifiée.	corde
partitionnement	Propriétés de partitionnement du cluster mongo.	ShardingProperties
stockage	Propriétés de stockage du cluster mongo.	StorageProperties

MongoClusterReplicaParameters

Nom	Description	Valeur
sourceLocation	Emplacement du cluster source	chaîne (obligatoire)
sourceResourceId	ID du cluster source de réplication.	chaîne (obligatoire)

MongoClusterRestoreParameters

Nom	Description	Valeur
pointInTimeUTC	Point UTC dans le temps pour restaurer un cluster mongo	corde
sourceResourceId	ID de ressource pour localiser le cluster source à restaurer	corde

ShardingProperties

Nom	Description	Valeur
shardCount	Nombre de partitions à provisionner sur le cluster.	Int

StorageProperties

Nom	Description	Valeur
sizeGb	Taille du disque de données affecté à chaque serveur.	Int

TrackedResourceTags

Nom	Description	Valeur

Définition de ressource de modèle ARM

Le type de ressource mongoClusters 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/mongoClusters, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.DocumentDB/mongoClusters",
  "apiVersion": "2024-10-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "administrator": {
      "password": "string",
      "userName": "string"
    },
    "backup": {
    },
    "compute": {
      "tier": "string"
    },
    "createMode": "string",
    "dataApi": {
      "mode": "string"
    },
    "highAvailability": {
      "targetMode": "string"
    },
    "previewFeatures": [ "string" ],
    "publicNetworkAccess": "string",
    "replicaParameters": {
      "sourceLocation": "string",
      "sourceResourceId": "string"
    },
    "restoreParameters": {
      "pointInTimeUTC": "string",
      "sourceResourceId": "string"
    },
    "serverVersion": "string",
    "sharding": {
      "shardCount": "int"
    },
    "storage": {
      "sizeGb": "int"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

AdministratorProperties

Nom	Description	Valeur
mot de passe	Mot de passe administrateur.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
nom d’utilisateur	Nom d’utilisateur administrateur.	corde

BackupProperties

Nom	Description	Valeur

ComputeProperties

Nom	Description	Valeur
niveau	Niveau de calcul à affecter au cluster, où chaque niveau est mappé à une taille de cœur virtuel et de mémoire. Exemples de valeurs : « M30 », « M40 ».	corde

DataApiProperties

Nom	Description	Valeur
mode	Mode pour indiquer si l’API Mongo Data est activée pour un cluster.	'Désactivé' 'Activé'

HighAvailabilityProperties

Nom	Description	Valeur
targetMode	Mode de haute disponibilité cible demandé pour le cluster.	'Désactivé' 'SameZone' 'ZoneRedundantPreferred'

Microsoft.DocumentDB/mongoClusters

Nom	Description	Valeur
apiVersion	Version de l’API	'2024-10-01-preview'
emplacement	Emplacement géographique où réside la ressource	chaîne (obligatoire)
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 3 Longueur maximale = 3 Modèle = `^[a-z0-9]+(-[a-z0-9]+)*` (obligatoire)
Propriétés	Propriétés spécifiques à la ressource pour cette ressource.	MongoClusterProperties
é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/mongoClusters'

MongoClusterProperties

Nom	Description	Valeur
administrateur	Propriétés de l’administrateur local pour le cluster mongo.	AdministratorProperties
sauvegarde	Propriétés de sauvegarde du cluster mongo.	BackupProperties
calculer	Propriétés de calcul du cluster mongo.	ComputeProperties
createMode	Mode de création d’un cluster mongo.	'Default' 'GeoReplica' 'PointInTimeRestore' 'Replica'
dataApi	Propriétés de l’API de données du cluster mongo.	DataApiProperties
highAvailability	Propriétés de haute disponibilité du cluster mongo.	HighAvailabilityProperties
previewFeatures	Liste des connexions de point de terminaison privé.	Tableau de chaînes contenant l’un des éléments suivants : 'GeoReplicas'
publicNetworkAccess	Indique si l’accès au point de terminaison public est autorisé pour ce cluster mongo.	'Désactivé' 'Activé'
replicaParameters	Paramètres permettant de créer un cluster mongo de réplica.	MongoClusterReplicaParameters
restoreParameters	Paramètres permettant de créer un cluster mongo de restauration à un point dans le temps.	MongoClusterRestoreParameters
serverVersion	Version du serveur Mongo DB. La valeur par défaut est la dernière version disponible si elle n’est pas spécifiée.	corde
partitionnement	Propriétés de partitionnement du cluster mongo.	ShardingProperties
stockage	Propriétés de stockage du cluster mongo.	StorageProperties

MongoClusterReplicaParameters

Nom	Description	Valeur
sourceLocation	Emplacement du cluster source	chaîne (obligatoire)
sourceResourceId	ID du cluster source de réplication.	chaîne (obligatoire)

MongoClusterRestoreParameters

Nom	Description	Valeur
pointInTimeUTC	Point UTC dans le temps pour restaurer un cluster mongo	corde
sourceResourceId	ID de ressource pour localiser le cluster source à restaurer	corde

ShardingProperties

Nom	Description	Valeur
shardCount	Nombre de partitions à provisionner sur le cluster.	Int

StorageProperties

Nom	Description	Valeur
sizeGb	Taille du disque de données affecté à chaque serveur.	Int

TrackedResourceTags

Nom	Description	Valeur

Définition de ressource Terraform (fournisseur AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters@2024-10-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      administrator = {
        password = "string"
        userName = "string"
      }
      backup = {
      }
      compute = {
        tier = "string"
      }
      createMode = "string"
      dataApi = {
        mode = "string"
      }
      highAvailability = {
        targetMode = "string"
      }
      previewFeatures = [
        "string"
      ]
      publicNetworkAccess = "string"
      replicaParameters = {
        sourceLocation = "string"
        sourceResourceId = "string"
      }
      restoreParameters = {
        pointInTimeUTC = "string"
        sourceResourceId = "string"
      }
      serverVersion = "string"
      sharding = {
        shardCount = int
      }
      storage = {
        sizeGb = int
      }
    }
  })
}

Valeurs de propriété

AdministratorProperties

Nom	Description	Valeur
mot de passe	Mot de passe administrateur.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
nom d’utilisateur	Nom d’utilisateur administrateur.	corde

BackupProperties

Nom	Description	Valeur

ComputeProperties

Nom	Description	Valeur
niveau	Niveau de calcul à affecter au cluster, où chaque niveau est mappé à une taille de cœur virtuel et de mémoire. Exemples de valeurs : « M30 », « M40 ».	corde

DataApiProperties

Nom	Description	Valeur
mode	Mode pour indiquer si l’API Mongo Data est activée pour un cluster.	'Désactivé' 'Activé'

HighAvailabilityProperties

Nom	Description	Valeur
targetMode	Mode de haute disponibilité cible demandé pour le cluster.	'Désactivé' 'SameZone' 'ZoneRedundantPreferred'

Microsoft.DocumentDB/mongoClusters

Nom	Description	Valeur
emplacement	Emplacement géographique où réside la ressource	chaîne (obligatoire)
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 3 Longueur maximale = 3 Modèle = `^[a-z0-9]+(-[a-z0-9]+)*` (obligatoire)
Propriétés	Propriétés spécifiques à la ressource pour cette ressource.	MongoClusterProperties
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
type	Type de ressource	« Microsoft.DocumentDB/mongoClusters@2024-10-01-preview »

MongoClusterProperties

Nom	Description	Valeur
administrateur	Propriétés de l’administrateur local pour le cluster mongo.	AdministratorProperties
sauvegarde	Propriétés de sauvegarde du cluster mongo.	BackupProperties
calculer	Propriétés de calcul du cluster mongo.	ComputeProperties
createMode	Mode de création d’un cluster mongo.	'Default' 'GeoReplica' 'PointInTimeRestore' 'Replica'
dataApi	Propriétés de l’API de données du cluster mongo.	DataApiProperties
highAvailability	Propriétés de haute disponibilité du cluster mongo.	HighAvailabilityProperties
previewFeatures	Liste des connexions de point de terminaison privé.	Tableau de chaînes contenant l’un des éléments suivants : 'GeoReplicas'
publicNetworkAccess	Indique si l’accès au point de terminaison public est autorisé pour ce cluster mongo.	'Désactivé' 'Activé'
replicaParameters	Paramètres permettant de créer un cluster mongo de réplica.	MongoClusterReplicaParameters
restoreParameters	Paramètres permettant de créer un cluster mongo de restauration à un point dans le temps.	MongoClusterRestoreParameters
serverVersion	Version du serveur Mongo DB. La valeur par défaut est la dernière version disponible si elle n’est pas spécifiée.	corde
partitionnement	Propriétés de partitionnement du cluster mongo.	ShardingProperties
stockage	Propriétés de stockage du cluster mongo.	StorageProperties

MongoClusterReplicaParameters

Nom	Description	Valeur
sourceLocation	Emplacement du cluster source	chaîne (obligatoire)
sourceResourceId	ID du cluster source de réplication.	chaîne (obligatoire)

MongoClusterRestoreParameters

Nom	Description	Valeur
pointInTimeUTC	Point UTC dans le temps pour restaurer un cluster mongo	corde
sourceResourceId	ID de ressource pour localiser le cluster source à restaurer	corde

ShardingProperties

Nom	Description	Valeur
shardCount	Nombre de partitions à provisionner sur le cluster.	Int

StorageProperties

Nom	Description	Valeur
sizeGb	Taille du disque de données affecté à chaque serveur.	Int

TrackedResourceTags

Nom	Description	Valeur

Partager via

Microsoft.DocumentDB mongoClusters

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

AdministratorProperties

BackupProperties

ComputeProperties

DataApiProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

AdministratorProperties

BackupProperties

ComputeProperties

DataApiProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

AdministratorProperties

BackupProperties

ComputeProperties

DataApiProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

Commentaires

Ressources supplémentaires