az documentdb mongocluster replica

  • Anteprima

Annotazioni

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 replica . Altre informazioni sulle estensioni.

Il gruppo di comandi 'az documentdb mongocluster' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Gestire replica.

Comandi

Nome Descrizione Tipo Status
az documentdb mongocluster replica create

Creare una replica in lettura di un cluster mongo esistente.

 Extension Preview
az documentdb mongocluster replica list

Elencare tutte le repliche per il cluster mongo.

 Extension Preview
az documentdb mongocluster replica promote

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

 Extension Preview

az documentdb mongocluster replica create

Anteprima

Il gruppo di comandi 'az documentdb mongocluster replica' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Creare una replica in lettura di un cluster mongo esistente.

Il cluster di origine deve avere la funzionalità di anteprima "GeoReplicas" abilitata. Il provisioning della replica viene effettuato come nuovo cluster mongo e ne eredita la configurazione (calcolo, archiviazione, partizionamento orizzontale) dal cluster di origine. Una replica nella stessa area dell'origine viene creata come in un'area AsyncReplica. Una replica in un'area diversa viene creata come area tra GeoAsyncReplicaaree.

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

Esempio

Creare una replica di un cluster.

az documentdb mongocluster replica create -n MyReplica -g MyResourceGroup --location centralus --source-cluster MySourceCluster

Parametri necessari

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

--source-cluster

Nome o ID risorsa del cluster mongo di origine (primario) da cui eseguire la replica. Se viene assegnato un nome, vengono considerati la sottoscrizione corrente e il gruppo di risorse. Specificare un ID ARM completo per un'origine in un altro gruppo di risorse o sottoscrizione.

Proprietà Valore
Gruppo di parametri: Replica 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 replica list

Anteprima

Il gruppo di comandi 'az documentdb mongocluster replica' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Elencare tutte le repliche per il cluster mongo.

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

Esempio

Elencare le repliche di un cluster.

az documentdb mongocluster replica list --source-cluster MyCluster -g MyResourceGroup

Parametri necessari

--resource-group -g

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

--source-cluster

Nome del cluster mongo di origine.

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
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 replica promote

Anteprima

Il gruppo di comandi 'az documentdb mongocluster replica' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

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

az documentdb mongocluster replica promote --promote-option {Forced}
                                           --source-cluster
                                           [--acquire-policy-token]
                                           [--change-reference]
                                           [--ids]
                                           [--mode {Switchover}]
                                           [--name]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-group]
                                           [--subscription]
                                           [--yes]

Esempio

Alzare di livello una replica a primaria.

az documentdb mongocluster replica promote -n MyReplica -g MyResourceGroup --mode Switchover --promote-option Forced

Parametri necessari

--promote-option

Opzione di promozione da applicare all'operazione.

Proprietà Valore
Gruppo di parametri: Body Arguments
Valori accettati: Forced
--source-cluster

Nome o ID risorsa del cluster di origine (primario) previsto di questa replica. L'innalzamento di livello procede solo se corrisponde al cluster di origine effettivo della replica; in caso contrario, l'operazione non riesce.

Proprietà Valore
Gruppo di parametri: Replica 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
--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
--mode

Modalità da applicare all'operazione di promozione. Il valore è facoltativo e il valore predefinito è 'Switchover'.

Proprietà Valore
Gruppo di parametri: Body Arguments
Valori accettati: Switchover
--name -n

Nome della replica da alzare di livello.

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