az documentdb mongocluster

Note

Questo riferimento fa parte dell'estensione documentdb per il interfaccia della riga di comando di Azure (versione 2.75.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az documentdb mongocluster . Altre informazioni sulle estensioni.

Gestire il cluster Mongo.

Comandi

Nome Descrizione Tipo Status
az documentdb mongocluster check-name-availability

Controllare se il nome del cluster mongo è disponibile per l'uso.

Extension GA
az documentdb mongocluster create

Creare un cluster mongo. L'aggiornamento sovrascrive tutte le proprietà per la risorsa. Per modificare solo alcune delle proprietà, usare PATCH.

Extension GA
az documentdb mongocluster delete

Eliminare un cluster mongo.

Extension GA
az documentdb mongocluster firewall-rule

Gestire la regola del firewall.

Extension GA
az documentdb mongocluster firewall-rule create

Creare una nuova regola del firewall o aggiornare una regola del firewall esistente in un cluster mongo.

Extension GA
az documentdb mongocluster firewall-rule delete

Eliminare una regola del firewall del cluster mongo.

Extension GA
az documentdb mongocluster firewall-rule list

Elencare tutte le regole del firewall in un determinato cluster mongo.

Extension GA
az documentdb mongocluster firewall-rule show

Ottenere informazioni su una regola del firewall del cluster mongo.

Extension GA
az documentdb mongocluster firewall-rule update

Aggiornare una nuova regola del firewall o aggiornare una regola del firewall esistente in un cluster mongo.

Extension GA
az documentdb mongocluster firewall-rule wait

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione.

Extension GA
az documentdb mongocluster identity

Gestire l'identità.

Extension GA
az documentdb mongocluster identity assign

Assegnare le identità gestite dall'utente o dal sistema.

Extension GA
az documentdb mongocluster identity remove

Rimuovere le identità gestite dall'utente o dal sistema.

Extension GA
az documentdb mongocluster identity show

Visualizzare i dettagli delle identità gestite.

Extension GA
az documentdb mongocluster identity wait

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione.

Extension GA
az documentdb mongocluster list

Elencare tutti i cluster mongo in una determinata sottoscrizione.

Extension GA
az documentdb mongocluster list-connection-strings

Elencare le stringhe di connessione del cluster mongo. Include la stringa di connessione predefinita che usa SCRAM-SHA-256, nonché altre stringhe di connessione supportate dal cluster.

Extension GA
az documentdb mongocluster replica

Gestire replica.

Extension GA
az documentdb mongocluster replica create

Creare una replica in lettura tra aree di un cluster mongo esistente.

Extension GA
az documentdb mongocluster replica list

Elencare tutte le repliche per il cluster mongo.

Extension GA
az documentdb mongocluster replica promote

Alza di livello un cluster mongo di replica a un ruolo primario.

Extension GA
az documentdb mongocluster reset-password

Reimpostare la password dell'amministratore di un cluster mongo.

Extension GA
az documentdb mongocluster restore

Ripristinare un cluster mongo in un nuovo cluster da un momento specifico.

Extension GA
az documentdb mongocluster show

Ottenere informazioni su un cluster mongo.

Extension GA
az documentdb mongocluster update

Aggiornare un cluster mongo. L'aggiornamento sovrascrive tutte le proprietà per la risorsa. Per modificare solo alcune delle proprietà, usare PATCH.

Extension GA
az documentdb mongocluster user

Gestisci utente.

Extension GA
az documentdb mongocluster user create

Creare un nuovo utente o aggiornare un utente esistente in un cluster mongo.

Extension GA
az documentdb mongocluster user delete

Eliminare un utente del cluster mongo.

Extension GA
az documentdb mongocluster user list

Elencare tutti gli utenti in un cluster mongo.

Extension GA
az documentdb mongocluster user show

Ottenere la definizione di un utente del cluster Mongo.

Extension GA
az documentdb mongocluster user update

Aggiornare un nuovo utente o aggiornare un utente esistente in un cluster mongo.

Extension GA
az documentdb mongocluster user wait

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione.

Extension GA
az documentdb mongocluster wait

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione.

Extension GA

az documentdb mongocluster check-name-availability

Controllare se il nome del cluster mongo è disponibile per l'uso.

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

Esempio

Controllare se il nome di un cluster mongo è disponibile.

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

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--location -l

Location. Usare i valori ottenuti con az account list-locations. È possibile configurare la posizione predefinito con az configure --defaults location=<location>.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--name

Nome della risorsa per cui deve essere verificata la disponibilità.

Proprietà Valore
Gruppo di parametri: Body Arguments
--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--type

Tipo di risorsa.

Proprietà Valore
Gruppo di parametri: Body Arguments
Valore predefinito: Microsoft.DocumentDB/mongoClusters
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az documentdb mongocluster create

Creare un cluster mongo. L'aggiornamento sovrascrive tutte le proprietà per la risorsa. Per modificare solo alcune delle proprietà, usare PATCH.

az documentdb mongocluster create --admin-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]

Esempio

Creare un cluster mongo con l'archiviazione 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

Parametri necessari

--admin-password -p

Password amministratore. Se il valore è vuoto, viene chiesto dal tty.

Proprietà Valore
Gruppo di parametri: Administrator Arguments
--admin-user -u

Nome utente amministratore.

Proprietà Valore
Gruppo di parametri: Administrator Arguments
--cluster-name --name -n

Nome del cluster mongo.

--high-availability

Modalità di disponibilità elevata di destinazione richiesta per il cluster.

Proprietà Valore
Gruppo di parametri: HighAvailability Arguments
Valori accettati: Disabled, SameZone, ZoneRedundantPreferred
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--shard-count

Numero di partizioni di cui eseguire il provisioning nel cluster.

Proprietà Valore
Gruppo di parametri: Sharding Arguments
--storage-size

Dimensioni del disco dati assegnato a ogni server.

Proprietà Valore
Gruppo di parametri: Storage Arguments
--tier

Livello di calcolo da assegnare al cluster, in cui ogni livello esegue il mapping a una dimensione di memoria e core virtuale. Valori di esempio: 'M30', 'M40'.

Proprietà Valore
Gruppo di parametri: Compute Arguments

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--auth-allowed-modes

Elenco separato da spazi di modalità di autenticazione consentite per l'accesso ai dati. Valori consentiti: NativeAuth, MicrosoftEntraID. Esempio: --auth-allowed-modes NativeAuth MicrosoftEntraID Supporta la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Proprietà Valore
Gruppo di parametri: AuthConfig Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--data-api-mode

Abilitare o disabilitare l'API Dati Mongo nel cluster. Valori consentiti: Enabled, Disabled. Esempio: --data-api-mode Abilitato.

Proprietà Valore
Gruppo di parametri: DataApi Arguments
Valori accettati: Disabled, Enabled
--encryption

Configurazione della crittografia per il cluster. Dipende dall'identità configurata. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Proprietà Valore
Gruppo di parametri: Properties Arguments
--location -l

Posizione geografica in cui si trova la risorsa Se non specificato, verrà usata la posizione del gruppo di risorse.

Proprietà Valore
Gruppo di parametri: Resource Arguments
--mi-user-assigned --user-assigned

Impostare le identità gestite dall'utente. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Proprietà Valore
Gruppo di parametri: Identity Arguments
--network-bypass-mode

La modalità bypass di rete per il cluster. Impostando su 'AzureCosmosDB' il servizio Azure Cosmos DB consente di bypassare le restrizioni di rete.

Proprietà Valore
Gruppo di parametri: Properties Arguments
Valori accettati: AzureCosmosDB, None
--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Proprietà Valore
Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--preview-features

Elenco delle connessioni endpoint private. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Proprietà Valore
Gruppo di parametri: Properties Arguments
--public-network-access

Indica se l'accesso all'endpoint pubblico è consentito per questo cluster mongo.

Proprietà Valore
Gruppo di parametri: Properties Arguments
Valori accettati: Disabled, Enabled
--server-version

Versione del server Mongo DB. L'impostazione predefinita è la versione disponibile più recente, se non specificata.

Proprietà Valore
Gruppo di parametri: Properties Arguments
--storage-type

Tipo di archiviazione con cui eseguire il provisioning dei server cluster.

Proprietà Valore
Gruppo di parametri: Storage Arguments
Valori accettati: PremiumSSD, PremiumSSDv2
--tags

Tag delle risorse. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Proprietà Valore
Gruppo di parametri: Resource Arguments
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az documentdb mongocluster delete

Eliminare 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]

Esempio

Eliminare un cluster mongo.

az documentdb mongocluster delete -n MyCluster -g MyResourceGroup

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--cluster-name --name -n

Nome del cluster mongo.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Proprietà Valore
Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--yes -y

Non richiedere conferma.

Proprietà Valore
Valore predefinito: False
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az documentdb mongocluster list

Elencare tutti i cluster mongo in una determinata sottoscrizione.

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

Esempio

Elencare tutti i cluster mongo in un gruppo di risorse.

az documentdb mongocluster list -g MyResourceGroup

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--max-items

Numero totale di elementi da restituire nell'output del comando. Se il numero totale di elementi disponibili è maggiore del valore specificato, nell'output del comando viene fornito un token. Per riprendere la paginazione, specificare il valore del token in --next-token argomento di un comando successivo.

Proprietà Valore
Gruppo di parametri: Pagination Arguments
--next-token

Token per specificare dove iniziare la paginazione. Si tratta del valore del token di una risposta troncata in precedenza.

Proprietà Valore
Gruppo di parametri: Pagination Arguments
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az documentdb mongocluster list-connection-strings

Elencare le stringhe di connessione del cluster mongo. Include la stringa di connessione predefinita che usa SCRAM-SHA-256, nonché altre stringhe di connessione supportate dal cluster.

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

Esempio

Elencare le stringhe di connessione per un cluster mongo.

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

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--cluster-name

Nome del cluster mongo.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az documentdb mongocluster reset-password

Reimpostare la password dell'amministratore di un cluster mongo.

az documentdb mongocluster reset-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]

Esempio

Reimpostare la password dell'amministratore.

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

Parametri necessari

--password -p

Nuova password amministratore. Se il valore è vuoto, viene chiesto dal tty.

Proprietà Valore
Gruppo di parametri: Administrator Arguments

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--cluster-name --name -n

Nome del cluster mongo.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Proprietà Valore
Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az documentdb mongocluster restore

Ripristinare un cluster mongo in un nuovo cluster da un momento specifico.

Crea un nuovo cluster mongo dal backup di un cluster di origine esistente (o eliminato) nel momento richiesto.

az documentdb mongocluster restore --admin-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}]

Esempio

Ripristinare un cluster a un punto nel tempo.

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!

Parametri necessari

--admin-password -p

Password amministratore. Se il valore è vuoto, viene chiesto dal tty.

Proprietà Valore
Gruppo di parametri: Administrator Arguments
--admin-user -u

Nome utente amministratore.

Proprietà Valore
Gruppo di parametri: Administrator Arguments
--cluster-name --name -n

Nome del cluster mongo.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--restore-time

Ora UTC da cui eseguire il ripristino, in formato ISO-8601 (ad esempio: 2026-06-30T10:00:00Z).

Proprietà Valore
Gruppo di parametri: Restore Arguments
--source-cluster

Nome o ID risorsa del cluster mongo di origine da cui eseguire il ripristino. Se viene assegnato un nome, vengono considerati la sottoscrizione e il gruppo di risorse correnti.

Proprietà Valore
Gruppo di parametri: Restore Arguments

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--location -l

Posizione geografica in cui si trova la risorsa Se non specificato, verrà usata la posizione del gruppo di risorse.

Proprietà Valore
Gruppo di parametri: Resource Arguments
--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Proprietà Valore
Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az documentdb mongocluster show

Ottenere informazioni su un cluster mongo.

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

Esempio

Ottenere informazioni su un cluster mongo.

az documentdb mongocluster show -n MyCluster -g MyResourceGroup

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--cluster-name --name -n

Nome del cluster mongo.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az documentdb mongocluster update

Aggiornare un cluster mongo. L'aggiornamento sovrascrive tutte le proprietà per la risorsa. Per modificare solo alcune delle proprietà, usare PATCH.

az documentdb mongocluster update [--acquire-policy-token]
                                  [--add]
                                  [--admin-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]

Esempio

Aggiornare il livello di calcolo di un cluster mongo.

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

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--add

Aggiungere un oggetto a un elenco di oggetti specificando un percorso e coppie chiave-valore. Esempio: --add property.listProperty <key=value, string or JSON string>.

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
--admin-password -p

Password amministratore. Se il valore è vuoto, viene chiesto dal tty.

Proprietà Valore
Gruppo di parametri: Administrator Arguments
--admin-user -u

Nome utente amministratore.

Proprietà Valore
Gruppo di parametri: Administrator Arguments
--auth-allowed-modes

Elenco separato da spazi di modalità di autenticazione consentite per l'accesso ai dati. Valori consentiti: NativeAuth, MicrosoftEntraID. Esempio: --auth-allowed-modes NativeAuth MicrosoftEntraID Supporta la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Proprietà Valore
Gruppo di parametri: AuthConfig Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--cluster-name --name -n

Nome del cluster mongo.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--data-api-mode

Abilitare o disabilitare l'API Dati Mongo nel cluster. Valori consentiti: Enabled, Disabled. Esempio: --data-api-mode Abilitato.

Proprietà Valore
Gruppo di parametri: DataApi Arguments
Valori accettati: Disabled, Enabled
--encryption

Configurazione della crittografia per il cluster. Dipende dall'identità configurata. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Proprietà Valore
Gruppo di parametri: Properties Arguments
--force-string

Quando si usa 'set' o 'add', mantenere i valori letterali stringa anziché tentare di eseguire la conversione in JSON.

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--high-availability

Modalità di disponibilità elevata di destinazione richiesta per il cluster.

Proprietà Valore
Gruppo di parametri: HighAvailability Arguments
Valori accettati: Disabled, SameZone, ZoneRedundantPreferred
--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--network-bypass-mode

La modalità bypass di rete per il cluster. Impostando su 'AzureCosmosDB' il servizio Azure Cosmos DB consente di bypassare le restrizioni di rete.

Proprietà Valore
Gruppo di parametri: Properties Arguments
Valori accettati: AzureCosmosDB, None
--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Proprietà Valore
Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--preview-features

Elenco delle connessioni endpoint private. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Proprietà Valore
Gruppo di parametri: Properties Arguments
--public-network-access

Indica se l'accesso all'endpoint pubblico è consentito per questo cluster mongo.

Proprietà Valore
Gruppo di parametri: Properties Arguments
Valori accettati: Disabled, Enabled
--remove

Rimuovere una proprietà o un elemento da un elenco. Esempio: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--server-version

Versione del server Mongo DB. L'impostazione predefinita è la versione disponibile più recente, se non specificata.

Proprietà Valore
Gruppo di parametri: Properties Arguments
--set

Aggiornare un oggetto specificando un percorso di proprietà e un valore da impostare. Esempio: --set property1.property2=<value>.

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
--shard-count

Numero di partizioni di cui eseguire il provisioning nel cluster.

Proprietà Valore
Gruppo di parametri: Sharding Arguments
--storage-size

Dimensioni del disco dati assegnato a ogni server.

Proprietà Valore
Gruppo di parametri: Storage Arguments
--storage-type

Tipo di archiviazione con cui eseguire il provisioning dei server cluster.

Proprietà Valore
Gruppo di parametri: Storage Arguments
Valori accettati: PremiumSSD, PremiumSSDv2
--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--tags

Tag delle risorse. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Proprietà Valore
Gruppo di parametri: Resource Arguments
--tier

Livello di calcolo da assegnare al cluster, in cui ogni livello esegue il mapping a una dimensione di memoria e core virtuale. Valori di esempio: 'M30', 'M40'.

Proprietà Valore
Gruppo di parametri: Compute Arguments
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az documentdb mongocluster wait

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione.

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

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--cluster-name --name -n

Nome del cluster mongo.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--created

Attendere fino a quando non viene creato con 'provisioningState' in 'Succeeded'.

Proprietà Valore
Gruppo di parametri: Wait Condition Arguments
Valore predefinito: False
--custom

Attendere che la condizione soddisfi una query JMESPath personalizzata. Ad esempio provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Proprietà Valore
Gruppo di parametri: Wait Condition Arguments
--deleted

Attendere l'eliminazione.

Proprietà Valore
Gruppo di parametri: Wait Condition Arguments
Valore predefinito: False
--exists

Attendere che la risorsa esista.

Proprietà Valore
Gruppo di parametri: Wait Condition Arguments
Valore predefinito: False
--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--interval

Intervallo di polling in secondi.

Proprietà Valore
Gruppo di parametri: Wait Condition Arguments
Valore predefinito: 30
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--timeout

Attesa massima in secondi.

Proprietà Valore
Gruppo di parametri: Wait Condition Arguments
Valore predefinito: 3600
--updated

Attendere fino a quando non viene aggiornato con provisioningState in 'Succeeded'.

Proprietà Valore
Gruppo di parametri: Wait Condition Arguments
Valore predefinito: False
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False