az documentdb mongocluster replica
Hinweis
Diese Referenz ist Teil der documentdb-Erweiterung für die Azure CLI (Version 2.75.0 oder höher). Die Erweiterung installiert automatisch, wenn Sie einen az documentdb mongocluster-Replikatbefehl zum ersten Mal ausführen. Erfahren Sie mehr über Erweiterungen.
Replikat verwalten.
Befehle
| Name | Beschreibung | Typ | Status |
|---|---|---|---|
| az documentdb mongocluster replica create |
Erstellen Sie ein regionsübergreifendes Lesereplikat eines vorhandenen Mongoclusters. |
Extension | GA |
| az documentdb mongocluster replica list |
Listet alle Replikate für den Mongocluster auf. |
Extension | GA |
| az documentdb mongocluster replica promote |
Stuft einen Replikatmongocluster zu einer primären Rolle hoch. |
Extension | GA |
az documentdb mongocluster replica create
Erstellen Sie ein regionsübergreifendes Lesereplikat eines vorhandenen Mongoclusters.
Der Quellcluster muss die Vorschaufunktion "GeoReplicas" aktiviert haben. Das Replikat wird als neuer Mongocluster in der Zielregion bereitgestellt und erbt seine Konfiguration (Compute, Speicher, Sharding) vom Quellcluster.
az documentdb mongocluster replica create --cluster-name --name
--resource-group
--source-cluster
--source-location
[--acquire-policy-token]
[--change-reference]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
Beispiele
Erstellen Sie ein Replikat eines Clusters in einer anderen Region.
az documentdb mongocluster replica create -n MyReplica -g MyResourceGroup --location centralus --source-cluster MySourceCluster --source-location eastus2
Erforderliche Parameter
Der Name des Mongoclusters.
Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.
Name oder Ressourcen-ID des Quell-Mongoclusters, aus dem repliziert werden soll. Wenn ein Name angegeben wird, wird die aktuelle Abonnement- und Ressourcengruppe angenommen.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Replica Arguments |
Die Azure Region des Quellclusters (z. B. Eastus2).
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Replica Arguments |
Optionale Parameter
Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.
Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
Der geografische Standort, an dem sich die Ressource befindet, wenn nicht angegeben, wird der Standort der Ressourcengruppe verwendet.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Resource Arguments |
Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.
| Eigenschaft | Wert |
|---|---|
| Zulässige Werte: | 0, 1, f, false, n, no, t, true, y, yes |
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
az documentdb mongocluster replica list
Listet alle Replikate für den Mongocluster auf.
az documentdb mongocluster replica list --cluster-name
--resource-group
[--max-items]
[--next-token]
Beispiele
Auflisten von Replikaten eines Clusters.
az documentdb mongocluster replica list --cluster-name MyCluster -g MyResourceGroup
Erforderliche Parameter
Der Name des Mongoclusters.
Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.
Optionale Parameter
Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.
Die Gesamtanzahl der Elemente, die in der Ausgabe des Befehls zurückgegeben werden sollen. Wenn die Gesamtanzahl der verfügbaren Elemente größer als der angegebene Wert ist, wird ein Token in der Ausgabe des Befehls bereitgestellt. Um die Paginierung fortzusetzen, geben Sie den Tokenwert in --next-token Argument eines nachfolgenden Befehls an.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Pagination Arguments |
Token, das angibt, wo die Paginierung beginnen soll. Dies ist der Tokenwert aus einer zuvor abgeschnittenen Antwort.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Pagination Arguments |
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
az documentdb mongocluster replica promote
Stuft einen Replikatmongocluster zu einer primären Rolle hoch.
az documentdb mongocluster replica promote --promote-option {Forced}
[--acquire-policy-token]
[--change-reference]
[--ids]
[--mode {Switchover}]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Beispiele
Höherstufen eines Replikats in den primären.
az documentdb mongocluster replica promote -n MyReplica -g MyResourceGroup --mode Switchover --promote-option Forced
Erforderliche Parameter
Die Höherstufenoption, die auf den Vorgang angewendet werden soll.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Body Arguments |
| Zulässige Werte: | Forced |
Optionale Parameter
Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.
Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Resource Id Arguments |
Der Modus, der auf den Heraufstufenvorgang angewendet werden soll. Der Wert ist optional, und der Standardwert ist "Switchover".
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Body Arguments |
| Zulässige Werte: | Switchover |
Der Name des zu bewerbenden Replikats.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Resource Id Arguments |
Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.
| Eigenschaft | Wert |
|---|---|
| Zulässige Werte: | 0, 1, f, false, n, no, t, true, y, yes |
Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Resource Id Arguments |
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Resource Id Arguments |
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |