az documentdb mongocluster

  • Préversion

Note

Cette référence fait partie de l’extension documentdb pour la Azure CLI (version 2.75.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande az documentdb mongocluster . Apprenez-en davantage sur les extensions.

Le groupe de commandes « az documentdb » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Gérez Azure clusters mongo DocumentDB.

Commandes

Nom Description Type État
az documentdb mongocluster check-name-availability

Vérifiez si le nom du cluster mongo est disponible pour une utilisation.

 Extension Preview
az documentdb mongocluster create

Créez un cluster mongo. La mise à jour remplace toutes les propriétés de la ressource. Pour modifier uniquement certaines des propriétés, utilisez PATCH.

 Extension Preview
az documentdb mongocluster delete

Supprimez un cluster mongo.

 Extension Preview
az documentdb mongocluster firewall-rule

Gérer la règle de pare-feu.

 Extension Preview
az documentdb mongocluster firewall-rule create

Créez une règle de pare-feu ou met à jour une règle de pare-feu existante sur un cluster mongo.

 Extension Preview
az documentdb mongocluster firewall-rule delete

Supprimez une règle de pare-feu de cluster mongo.

 Extension Preview
az documentdb mongocluster firewall-rule list

Répertoriez toutes les règles de pare-feu dans un cluster mongo donné.

 Extension Preview
az documentdb mongocluster firewall-rule show

Obtenez des informations sur une règle de pare-feu de cluster mongo.

 Extension Preview
az documentdb mongocluster firewall-rule update

Mettez à jour une nouvelle règle de pare-feu ou mettez à jour une règle de pare-feu existante sur un cluster mongo.

 Extension Preview
az documentdb mongocluster firewall-rule wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition soit remplie.

 Extension Preview
az documentdb mongocluster identity

Gérer l’identité.

 Extension Preview
az documentdb mongocluster identity assign

Affectez les identités managées utilisateur ou système.

 Extension Preview
az documentdb mongocluster identity list

Répertoriez les identités managées affectées à un cluster mongo.

 Extension Preview
az documentdb mongocluster identity remove

Supprimez les identités managées utilisateur ou système.

 Extension Preview
az documentdb mongocluster identity show

Affichez les détails des identités managées.

 Extension Preview
az documentdb mongocluster identity wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition soit remplie.

 Extension Preview
az documentdb mongocluster list

Répertoriez tous les clusters mongo dans un abonnement donné.

 Extension Preview
az documentdb mongocluster list-connection-strings

Répertorier les chaînes de connexion de cluster mongo. Cela inclut la chaîne de connexion par défaut à l’aide de SCRAM-SHA-256, ainsi que d’autres chaînes de connexion prises en charge par le cluster.

 Extension Preview
az documentdb mongocluster microsoft-entra-user

Gérez Microsoft Entra ID utilisateurs sur un cluster mongo.

 Extension Preview
az documentdb mongocluster microsoft-entra-user assign

Accordez à un principal Microsoft Entra ID l’accès à un cluster mongo en lui affectant des rôles de base de données.

 Extension Preview
az documentdb mongocluster microsoft-entra-user list

Répertoriez les utilisateurs Microsoft Entra ID sur un cluster mongo.

 Extension Preview
az documentdb mongocluster microsoft-entra-user remove

Supprimez l'accès d'un principal Microsoft Entra ID d'un cluster mongo.

 Extension Preview
az documentdb mongocluster microsoft-entra-user show

Obtenez la définition d’un utilisateur Microsoft Entra ID sur un cluster mongo.

 Extension Preview
az documentdb mongocluster microsoft-entra-user wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition soit remplie.

 Extension Preview
az documentdb mongocluster replica

Gérer le réplica.

 Extension Preview
az documentdb mongocluster replica create

Créez un réplica en lecture d’un cluster mongo existant.

 Extension Preview
az documentdb mongocluster replica list

Répertorie tous les réplicas du cluster mongo.

 Extension Preview
az documentdb mongocluster replica promote

Promeut un cluster mongo de réplica en rôle principal.

 Extension Preview
az documentdb mongocluster reset-password

Réinitialisez le mot de passe administrateur d’un cluster mongo.

 Extension Preview
az documentdb mongocluster restore

Restaurez un cluster mongo vers un nouveau cluster à partir d’un point dans le temps.

 Extension Preview
az documentdb mongocluster show

Obtenez des informations sur un cluster mongo.

 Extension Preview
az documentdb mongocluster update

Mettez à jour un cluster mongo. Seules les propriétés spécifiées dans la demande sont modifiées ; toutes les autres propriétés restent inchangées (HTTP PATCH). Les arguments de mise à jour génériques (--set, --add, --remove) sont pris en charge.

 Extension Preview
az documentdb mongocluster wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition soit remplie.

 Extension Preview

az documentdb mongocluster check-name-availability

Préversion

Le groupe de commandes « az documentdb mongocluster » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Vérifiez si le nom du cluster mongo est disponible pour une utilisation.

az documentdb mongocluster check-name-availability [--acquire-policy-token]
                                                   [--change-reference]
                                                   [--ids]
                                                   [--location]
                                                   [--name]
                                                   [--subscription]
                                                   [--type]

Exemples

Vérifiez si un nom de cluster mongo est disponible.

az documentdb mongocluster check-name-availability --location eastus --name MyCluster

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--location -l

Location. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--name

Nom de la ressource pour laquelle la disponibilité doit être vérifiée.

Propriété Valeur
Groupe de paramètres: Body Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--type

Type de ressource.

Propriété Valeur
Groupe de paramètres: Body Arguments
Valeur par défaut: Microsoft.DocumentDB/mongoClusters
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az documentdb mongocluster create

Préversion

Le groupe de commandes « az documentdb mongocluster » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Créez un cluster mongo. La mise à jour remplace toutes les propriétés de la ressource. Pour modifier uniquement certaines des propriétés, utilisez PATCH.

az documentdb mongocluster create --admin-password --password
                                  --admin-user
                                  --cluster-name --name
                                  --high-availability {Disabled, SameZone, ZoneRedundantPreferred}
                                  --resource-group
                                  --shard-count
                                  --storage-size
                                  --tier
                                  [--acquire-policy-token]
                                  [--auth-allowed-modes]
                                  [--change-reference]
                                  [--data-api-mode {Disabled, Enabled}]
                                  [--encryption]
                                  [--location]
                                  [--mi-user-assigned --user-assigned]
                                  [--network-bypass-mode {AzureCosmosDB, None}]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--preview-features]
                                  [--public-network-access {Disabled, Enabled}]
                                  [--server-version]
                                  [--storage-type {PremiumSSD, PremiumSSDv2}]
                                  [--tags]

Exemples

Créez un cluster mongo avec stockage SSD Premium v2.

az documentdb mongocluster create -n MyCluster -g MyResourceGroup --location eastus --admin-user dbadmin --admin-password MyP@ssw0rd123! --tier M30 --storage-size 128 --storage-type PremiumSSDv2 --shard-count 1 --high-availability Disabled

Paramètres obligatoires

--admin-password --password -p

Mot de passe administrateur. Si la valeur est vide, elle est demandée à partir de la tty.

Propriété Valeur
Groupe de paramètres: Administrator Arguments
--admin-user -u

Nom d’utilisateur administrateur.

Propriété Valeur
Groupe de paramètres: Administrator Arguments
--cluster-name --name -n

Nom du cluster mongo.

--high-availability

Mode de haute disponibilité cible demandé pour le cluster.

Propriété Valeur
Groupe de paramètres: HighAvailability Arguments
Valeurs acceptées: Disabled, SameZone, ZoneRedundantPreferred
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--shard-count

Nombre de partitions à provisionner sur le cluster.

Propriété Valeur
Groupe de paramètres: Sharding Arguments
--storage-size

Taille du disque de données affecté à chaque serveur.

Propriété Valeur
Groupe de paramètres: Storage Arguments
--tier

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 ».

Propriété Valeur
Groupe de paramètres: Compute Arguments

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--auth-allowed-modes

Liste séparée par l’espace des modes d’authentification autorisés pour l’accès aux données. Valeurs autorisées : NativeAuth, MicrosoftEntraID. Exemple : --auth-allowed-modes NativeAuth MicrosoftEntraID Support shorthand-syntax, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété Valeur
Groupe de paramètres: AuthConfig Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--data-api-mode

Activez ou désactivez l’API Mongo Data sur le cluster. Valeurs autorisées : Activé, Désactivé. Exemple : --data-api-mode Activé.

Propriété Valeur
Groupe de paramètres: DataApi Arguments
Valeurs acceptées: Disabled, Enabled
--encryption

Configuration du chiffrement pour le cluster. Dépend de l’identité configurée. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--location -l

Emplacement géographique où la ressource se trouve quand elle n’est pas spécifiée, l’emplacement du groupe de ressources sera utilisé.

Propriété Valeur
Groupe de paramètres: Resource Arguments
--mi-user-assigned --user-assigned

Définissez les identités managées par l’utilisateur. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété Valeur
Groupe de paramètres: Identity Arguments
--network-bypass-mode

Le mode contournement réseau pour le cluster. En réglant sur « AzureCosmosDB » le service Azure Cosmos DB de contourner les restrictions réseau.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeurs acceptées: AzureCosmosDB, None
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--preview-features

Liste séparée par l’espace des fonctionnalités d’aperçu à activer sur le cluster. Les noms de fonctionnalités en préversion sont des chaînes de forme libre ; reportez-vous à la documentation des fonctionnalités du cluster mongo pour connaître les valeurs actuellement disponibles. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--public-network-access

Indique si l’accès au point de terminaison public est autorisé pour ce cluster mongo.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeurs acceptées: Disabled, Enabled
--server-version

Version du serveur Mongo DB. La valeur par défaut est la dernière version disponible si elle n’est pas spécifiée.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--storage-type

Type de stockage avec lequel provisionner les serveurs de cluster.

Propriété Valeur
Groupe de paramètres: Storage Arguments
Valeurs acceptées: PremiumSSD, PremiumSSDv2
--tags

Balises de ressources. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété Valeur
Groupe de paramètres: Resource Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az documentdb mongocluster delete

Préversion

Le groupe de commandes « az documentdb mongocluster » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Supprimez un cluster mongo.

az documentdb mongocluster delete [--acquire-policy-token]
                                  [--change-reference]
                                  [--cluster-name --name]
                                  [--ids]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--resource-group]
                                  [--subscription]
                                  [--yes]

Exemples

Supprimez un cluster mongo.

az documentdb mongocluster delete -n MyCluster -g MyResourceGroup

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--cluster-name --name -n

Nom du cluster mongo.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--yes -y

Ne pas demander de confirmation.

Propriété Valeur
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az documentdb mongocluster list

Préversion

Le groupe de commandes « az documentdb mongocluster » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Répertoriez tous les clusters mongo dans un abonnement donné.

az documentdb mongocluster list [--max-items]
                                [--next-token]
                                [--resource-group]

Exemples

Répertoriez tous les clusters mongo dans un groupe de ressources.

az documentdb mongocluster list -g MyResourceGroup

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--max-items

Nombre total d’éléments à retourner dans la sortie de la commande. Si le nombre total d’éléments disponibles est supérieur à la valeur spécifiée, un jeton est fourni dans la sortie de la commande. Pour reprendre la pagination, fournissez la valeur du jeton dans --next-token argument d’une commande suivante.

Propriété Valeur
Groupe de paramètres: Pagination Arguments
--next-token

Jeton pour spécifier où commencer la pagination. Il s’agit de la valeur du jeton d’une réponse tronquée précédemment.

Propriété Valeur
Groupe de paramètres: Pagination Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az documentdb mongocluster list-connection-strings

Préversion

Le groupe de commandes « az documentdb mongocluster » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Répertorier les chaînes de connexion de cluster mongo. Cela inclut la chaîne de connexion par défaut à l’aide de SCRAM-SHA-256, ainsi que d’autres chaînes de connexion prises en charge par le cluster.

az documentdb mongocluster list-connection-strings [--acquire-policy-token]
                                                   [--change-reference]
                                                   [--cluster-name]
                                                   [--ids]
                                                   [--resource-group]
                                                   [--subscription]

Exemples

Répertoriez les chaînes de connexion d’un cluster mongo.

az documentdb mongocluster list-connection-strings --cluster-name MyCluster -g MyResourceGroup

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--cluster-name

Nom du cluster mongo.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az documentdb mongocluster reset-password

Préversion

Le groupe de commandes « az documentdb mongocluster » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Réinitialisez le mot de passe administrateur d’un cluster mongo.

az documentdb mongocluster reset-password --admin-password --password
                                          [--acquire-policy-token]
                                          [--change-reference]
                                          [--cluster-name --name]
                                          [--ids]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--resource-group]
                                          [--subscription]

Exemples

Réinitialisez le mot de passe administrateur.

az documentdb mongocluster reset-password -n MyCluster -g MyResourceGroup --admin-password NewP@ssw0rd123!

Paramètres obligatoires

--admin-password --password -p

Nouveau mot de passe administrateur. Si la valeur est vide, elle est demandée à partir de la tty.

Propriété Valeur
Groupe de paramètres: Administrator Arguments

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--cluster-name --name -n

Nom du cluster mongo.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az documentdb mongocluster restore

Préversion

Le groupe de commandes « az documentdb mongocluster » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Restaurez un cluster mongo vers un nouveau cluster à partir d’un point dans le temps.

Crée un cluster mongo à partir de la sauvegarde d’un cluster source existant (ou supprimé) au moment demandé.

az documentdb mongocluster restore --admin-password --password
                                   --admin-user
                                   --cluster-name --name
                                   --resource-group
                                   --restore-time
                                   --source-cluster
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--location]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Exemples

Restaurez un cluster à un point dans le temps.

az documentdb mongocluster restore -n RestoredCluster -g MyResourceGroup --location eastus2 --source-cluster MySourceCluster --restore-time "2026-06-30T10:00:00Z" --admin-user dbadmin --admin-password MyP@ssw0rd123!

Paramètres obligatoires

--admin-password --password -p

Mot de passe administrateur. Si la valeur est vide, elle est demandée à partir de la tty.

Propriété Valeur
Groupe de paramètres: Administrator Arguments
--admin-user -u

Nom d’utilisateur administrateur.

Propriété Valeur
Groupe de paramètres: Administrator Arguments
--cluster-name --name -n

Nom du cluster mongo.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--restore-time

Point UTC dans le temps de restauration, au format ISO-8601 (par exemple : 2026-06-30T10:00:00Z).

Propriété Valeur
Groupe de paramètres: Restore Arguments
--source-cluster

Nom ou ID de ressource du cluster mongo source à partir duquel effectuer la restauration. Si un nom est donné, l’abonnement actuel et le groupe de ressources sont supposés.

Propriété Valeur
Groupe de paramètres: Restore Arguments

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--location -l

Emplacement géographique où la ressource se trouve quand elle n’est pas spécifiée, l’emplacement du groupe de ressources sera utilisé.

Propriété Valeur
Groupe de paramètres: Resource Arguments
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az documentdb mongocluster show

Préversion

Le groupe de commandes « az documentdb mongocluster » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Obtenez des informations sur un cluster mongo.

az documentdb mongocluster show [--cluster-name --name]
                                [--ids]
                                [--resource-group]
                                [--subscription]

Exemples

Obtenez des informations sur un cluster mongo.

az documentdb mongocluster show -n MyCluster -g MyResourceGroup

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--cluster-name --name -n

Nom du cluster mongo.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az documentdb mongocluster update

Préversion

Le groupe de commandes « az documentdb mongocluster » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Mettez à jour un cluster mongo. Seules les propriétés spécifiées dans la demande sont modifiées ; toutes les autres propriétés restent inchangées (HTTP PATCH). Les arguments de mise à jour génériques (--set, --add, --remove) sont pris en charge.

az documentdb mongocluster update [--acquire-policy-token]
                                  [--add]
                                  [--admin-password --password]
                                  [--admin-user]
                                  [--auth-allowed-modes]
                                  [--change-reference]
                                  [--cluster-name --name]
                                  [--data-api-mode {Disabled, Enabled}]
                                  [--encryption]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--high-availability {Disabled, SameZone, ZoneRedundantPreferred}]
                                  [--ids]
                                  [--network-bypass-mode {AzureCosmosDB, None}]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--preview-features]
                                  [--public-network-access {Disabled, Enabled}]
                                  [--remove]
                                  [--resource-group]
                                  [--server-version]
                                  [--set]
                                  [--shard-count]
                                  [--storage-size]
                                  [--storage-type {PremiumSSD, PremiumSSDv2}]
                                  [--subscription]
                                  [--tags]
                                  [--tier]

Exemples

Mettez à jour le niveau de calcul d’un cluster mongo.

az documentdb mongocluster update -n MyCluster -g MyResourceGroup --tier M40

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string or JSON string>.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
--admin-password --password -p

Mot de passe administrateur. Si la valeur est vide, elle est demandée à partir de la tty.

Propriété Valeur
Groupe de paramètres: Administrator Arguments
--admin-user -u

Nom d’utilisateur administrateur.

Propriété Valeur
Groupe de paramètres: Administrator Arguments
--auth-allowed-modes

Liste séparée par l’espace des modes d’authentification autorisés pour l’accès aux données. Valeurs autorisées : NativeAuth, MicrosoftEntraID. Exemple : --auth-allowed-modes NativeAuth MicrosoftEntraID Support shorthand-syntax, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété Valeur
Groupe de paramètres: AuthConfig Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--cluster-name --name -n

Nom du cluster mongo.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--data-api-mode

Activez ou désactivez l’API Mongo Data sur le cluster. Valeurs autorisées : Activé, Désactivé. Exemple : --data-api-mode Activé.

Propriété Valeur
Groupe de paramètres: DataApi Arguments
Valeurs acceptées: Disabled, Enabled
--encryption

Configuration du chiffrement pour le cluster. Dépend de l’identité configurée. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--high-availability

Mode de haute disponibilité cible demandé pour le cluster.

Propriété Valeur
Groupe de paramètres: HighAvailability Arguments
Valeurs acceptées: Disabled, SameZone, ZoneRedundantPreferred
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--network-bypass-mode

Le mode contournement réseau pour le cluster. En réglant sur « AzureCosmosDB » le service Azure Cosmos DB de contourner les restrictions réseau.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeurs acceptées: AzureCosmosDB, None
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--preview-features

Liste séparée par l’espace des fonctionnalités d’aperçu à activer sur le cluster. Les noms de fonctionnalités en préversion sont des chaînes de forme libre ; reportez-vous à la documentation des fonctionnalités du cluster mongo pour connaître les valeurs actuellement disponibles. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--public-network-access

Indique si l’accès au point de terminaison public est autorisé pour ce cluster mongo.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeurs acceptées: Disabled, Enabled
--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list <indexToRemove> OR --remove propertyToRemove.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--server-version

Version du serveur Mongo DB. La valeur par défaut est la dernière version disponible si elle n’est pas spécifiée.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=<value>.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
--shard-count

Nombre de partitions à provisionner sur le cluster.

Propriété Valeur
Groupe de paramètres: Sharding Arguments
--storage-size

Taille du disque de données affecté à chaque serveur.

Propriété Valeur
Groupe de paramètres: Storage Arguments
--storage-type

Type de stockage avec lequel provisionner les serveurs de cluster.

Propriété Valeur
Groupe de paramètres: Storage Arguments
Valeurs acceptées: PremiumSSD, PremiumSSDv2
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--tags

Balises de ressources. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété Valeur
Groupe de paramètres: Resource Arguments
--tier

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 ».

Propriété Valeur
Groupe de paramètres: Compute Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az documentdb mongocluster wait

Préversion

Le groupe de commandes « az documentdb mongocluster » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition soit remplie.

az documentdb mongocluster wait [--acquire-policy-token]
                                [--change-reference]
                                [--cluster-name --name]
                                [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--ids]
                                [--interval]
                                [--resource-group]
                                [--subscription]
                                [--timeout]
                                [--updated]

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--cluster-name --name -n

Nom du cluster mongo.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--created

Attendez la création avec « provisioningState » sur « Succeeded ».

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
--deleted

Attendez la suppression.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
--exists

Attendez que la ressource existe.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--interval

Intervalle d’interrogation en secondes.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: 30
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--timeout

Délai maximal d’attente en secondes.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: 3600
--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False